fix: BI-0 openapi external path (#1506)

Author: ovsds

lib/dl_app_api_base/dl_app_api_base/app.py

@@ -211,12 +211,12 @@ async def _get_aiohttp_subsystem_readiness_callbacks(
     async def _setup_openapi(self, app: aiohttp.web.Application) -> None:
         open_api_spec = await self._get_aiohttp_open_api_spec()
         open_api_handler = openapi.OpenApiHandler(raw_spec=open_api_spec.raw)
-        app.router.add_route("GET", self.settings.OPEN_API.spec_path, open_api_handler.process)
+        app.router.add_route("GET", self.settings.OPEN_API.SPEC_PATH, open_api_handler.process)
 
         if self.settings.OPEN_API.SWAGGER_UI_ENABLED:
             swagger_handler = openapi.SwaggerHandler.from_dependencies(
                 openapi.SwaggerHandlerDependencies(
-                    url_prefix=self.settings.OPEN_API.DOCS_PATH,
+                    url_prefix=self.settings.OPEN_API.EXTERNAL_DOCS_PATH,
                     config_url=self.settings.OPEN_API.SPEC_REL_URL,
                 )
             )
@@ -229,4 +229,7 @@ async def _get_aiohttp_open_api_spec(
         self,
     ) -> openapi.OpenApiSpec:
         routes = await self._get_aiohttp_app_routes()
-        return openapi.OpenApiSpec(routes=routes)
+        return openapi.OpenApiSpec(
+            routes=routes,
+            external_route_prefix=self.settings.OPEN_API.EXTERNAL_ROUTE_PREFIX,
+        )

lib/dl_app_api_base/dl_app_api_base/openapi/models.py

@@ -23,6 +23,7 @@ class Tag:
     info: Info | None = None
     tags: list[Tag] = attrs.field(factory=list)
     routes: Sequence[OpenApiRouteProtocol] = attrs.field(factory=list)
+    external_route_prefix: str = ""
 
     @property
     def raw(self) -> dict:
@@ -99,7 +100,7 @@ def raw(self) -> dict:
                         "application/json": {"schema": response_schema.model_json_schema()},
                     },
                 }
-            paths[route.path][route.method.lower()] = {
+            paths[f"{self.external_route_prefix}{route.path}"][route.method.lower()] = {
                 "tags": route.handler.OPENAPI_TAGS,
                 "summary": route.handler.OPENAPI_DESCRIPTION,
                 "parameters": parameters,

lib/dl_app_api_base/dl_app_api_base/openapi/settings.py

@@ -1,11 +1,23 @@
+import typing_extensions
+
 import dl_settings
 
 
 class OpenApiSettings(dl_settings.BaseSettings):
     DOCS_PATH: str = "/api/v1/docs"
     SPEC_REL_URL: str = "/spec.json"
     SWAGGER_UI_ENABLED: bool = True
+    EXTERNAL_ROUTE_PREFIX: str = ""
 
     @property
+    @typing_extensions.deprecated("Use SPEC_PATH instead", category=DeprecationWarning)
     def spec_path(self) -> str:
+        return self.SPEC_PATH
+
+    @property
+    def SPEC_PATH(self) -> str:
         return f"{self.DOCS_PATH}{self.SPEC_REL_URL}"
+
+    @property
+    def EXTERNAL_DOCS_PATH(self) -> str:
+        return f"{self.EXTERNAL_ROUTE_PREFIX}{self.DOCS_PATH}"