feat: openapi config override

docs_src/src/pages/documentation/api_reference/openapi.mdx

@@ -11,6 +11,10 @@ Out of the box, the following endpoints are setup for you:
 - `/docs` The Swagger UI
 - `/openapi.json` The JSON Specification
 
+To use a custom openapi configuration, you can:
+
+    - Place the `openapi.json` config file in the root directory.
+    - Or, pass the file path to the `openapi_file_path` parameter in the `Robyn()` constructor. (the parameter gets priority over the file).
 
 However, if you don't want to generate the OpenAPI docs, you can disable it by passing `--disable-openapi` flag while starting the application.
 

docs_src/src/pages/documentation/example_app/openapi.mdx

@@ -13,6 +13,11 @@ Out of the box, the following endpoints are setup for you:
 
 However, if you don't want to generate the OpenAPI docs, you can disable it by passing `--disable-openapi` flag while starting the application.
 
+To use a custom openapi configuration, you can:
+
+    - Place the `openapi.json` config file in the root directory.
+    - Or, pass the file path to the `openapi_file_path` parameter in the `Robyn()` constructor. (the parameter gets priority over the file).
+
 ```bash
 python app.py --disable-openapi
 ```

robyn/__init__.py

@@ -41,6 +41,7 @@ def __init__(
         self,
         file_object: str,
         config: Config = Config(),
+        openapi_file_path: str = None,
         openapi: OpenAPI = OpenAPI(),
         dependencies: DependencyMap = DependencyMap(),
     ) -> None:
@@ -51,6 +52,11 @@ def __init__(
         self.dependencies = dependencies
         self.openapi = openapi
 
+        if openapi_file_path:
+            openapi.set_json_spec(self.directory_path + "/" + openapi_file_path)
+        elif os.path.isfile(self.directory_path + "/openapi.json"):
+            openapi.set_json_spec(self.directory_path + "/openapi.json")
+
         if not bool(os.environ.get("ROBYN_CLI", False)):
             # the env variables are already set when are running through the cli
             load_vars(project_root=directory_path)
@@ -583,7 +589,7 @@ def configure_authentication(self, authentication_handler: AuthenticationHandler
 
 class SubRouter(Robyn):
     def __init__(self, file_object: str, prefix: str = "", config: Config = Config(), openapi: OpenAPI = OpenAPI()) -> None:
-        super().__init__(file_object, config, openapi)
+        super().__init__(file_object=file_object, config=config, openapi=openapi)
         self.prefix = prefix
 
     def __add_prefix(self, endpoint: str):

robyn/openapi.py

@@ -1,4 +1,5 @@
 import inspect
+import json
 import typing
 from dataclasses import asdict, dataclass, field
 from importlib import resources
@@ -138,11 +139,15 @@ class OpenAPI:
 
     info: OpenAPIInfo = field(default_factory=OpenAPIInfo)
     openapi_spec: dict = field(init=False)
+    openapi_file_override: bool = False  # denotes whether running in the pre-configured file mode or not.
 
     def __post_init__(self):
         """
         Initializes the openapi_spec dict
         """
+        if self.openapi_file_override:
+            return
+
         self.openapi_spec = {
             "openapi": "3.1.0",
             "info": asdict(self.info),
@@ -163,6 +168,9 @@ def add_openapi_path_obj(self, route_type: str, endpoint: str, openapi_name: str
         @param handler: Callable the handler function for the endpoint
         """
 
+        if self.openapi_file_override:
+            return
+
         query_params = None
         request_body = None
         return_annotation = None
@@ -212,6 +220,10 @@ def add_subrouter_paths(self, subrouter_openapi: "OpenAPI"):
 
         @param subrouter_openapi: OpenAPI the OpenAPI object of the current subrouter
         """
+
+        if self.openapi_file_override:
+            return
+
         paths = subrouter_openapi.openapi_spec["paths"]
 
         for path in paths:
@@ -393,6 +405,16 @@ def get_schema_object(self, parameter: str, param_type: Any) -> dict:
 
         return properties
 
+    def set_json_spec(self, openapi_json_spec_path: str):
+        """
+        Set a pre-configured OpenAPI spec
+        @param openapi_json_spec_path: str the path to the json file
+        """
+        with open(openapi_json_spec_path) as json_file:
+            json_file_content = json.load(json_file)
+            self.openapi_spec = dict(json_file_content)
+            self.openapi_file_override = True
+
     def get_openapi_docs_page(self) -> FileResponse:
         """
         Handler to the swagger html page to be deployed to the endpoint `/docs`