from typing import Any, Dict from fastapi import FastAPI from fastapi.routing import APIRoute from fastapi.openapi.utils import get_openapi from ApiServices.TemplateService.config import template_api_config class OpenAPISchemaCreator: """ OpenAPI schema creator and customizer for FastAPI applications. """ def __init__(self, app: FastAPI): """ Initialize the OpenAPI schema creator. Args: app: FastAPI application instance """ self.app = app def create_security_schemes(self) -> Dict[str, Any]: """ Create security scheme definitions. Returns: Dict[str, Any]: Security scheme configurations """ return { "BearerAuth": { "type": "apiKey", "in": "header", "name": template_api_config.ACCESS_TOKEN_TAG, "description": "Enter: **'Bearer <JWT>'**, where JWT is the access token", } } def create_schema(self) -> Dict[str, Any]: """ Create the complete OpenAPI schema. Returns: Dict[str, Any]: Complete OpenAPI schema """ openapi_schema = get_openapi( title=template_api_config.TITLE, description=template_api_config.DESCRIPTION, version=template_api_config, routes=self.app.routes, ) # Add security schemes if "components" not in openapi_schema: openapi_schema["components"] = {} openapi_schema["components"][ "securitySchemes" ] = self._create_security_schemes() # Configure route security and responses for route in self.app.routes: if isinstance(route, APIRoute) and route.include_in_schema: path = str(route.path) methods = [method.lower() for method in route.methods] for method in methods: self.configure_route_security(path, method, openapi_schema) # Add custom documentation extensions openapi_schema["x-documentation"] = { "postman_collection": "/docs/postman", "swagger_ui": "/docs", "redoc": "/redoc", } return openapi_schema def create_openapi_schema(app: FastAPI) -> Dict[str, Any]: """ Create OpenAPI schema for a FastAPI application. Args: app: FastAPI application instance Returns: Dict[str, Any]: Complete OpenAPI schema """ creator = OpenAPISchemaCreator(app) return creator.create_schema()