custom swagger docs

Signed-off-by: Vladimir Mandic <mandic00@live.com>
2026-09-18 16:54:33 +02:00 · 2024-11-14 10:11:20 -05:00
parent 4033f2b63f
commit 94b71003e0
5 changed files with 974 additions and 11 deletions
@@ -5,7 +5,7 @@ from fastapi import FastAPI, APIRouter, Depends, Request
 from fastapi.security import HTTPBasic, HTTPBasicCredentials
 from fastapi.exceptions import HTTPException
 from modules import errors, shared, postprocessing
-from modules.api import models, endpoints, script, helpers, server, nvml, generate, process, control, gallery
+from modules.api import models, endpoints, script, helpers, server, nvml, generate, process, control, gallery, docs


 errors.install()
@@ -23,8 +23,10 @@ class Api:
                for line in file.readlines():
                    user, password = line.split(":")
                    self.credentials[user.replace('"', '').strip()] = password.replace('"', '').strip()
-
        self.router = APIRouter()
+        if shared.cmd_opts.docs:
+            docs.create_docs(app)
+            docs.create_redocs(app)
        self.app = app
        self.queue_lock = queue_lock
        self.generate = generate.APIGenerate(queue_lock)
@@ -0,0 +1,96 @@
+import json
+from starlette.responses import HTMLResponse
+from fastapi import FastAPI
+from fastapi.openapi.docs import get_redoc_html, swagger_ui_default_parameters
+from fastapi.encoders import jsonable_encoder
+
+
+def get_swagger_ui_html(*,
+                        openapi_url: str,
+                        title: str,
+                        swagger_js_url: str = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js",
+                        swagger_css_url: str = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css",
+                        swagger_extra_css_url: str = None,
+                        swagger_favicon_url: str = "https://fastapi.tiangolo.com/img/favicon.png",
+                        oauth2_redirect_url: str = None,
+                        init_oauth: dict = None,
+                        swagger_ui_parameters: dict = None,
+                       ) -> HTMLResponse:
+    current_swagger_ui_parameters = swagger_ui_default_parameters.copy()
+    if swagger_ui_parameters:
+        current_swagger_ui_parameters.update(swagger_ui_parameters)
+    html = f"""
+        <!DOCTYPE html>
+        <html>
+        <head>
+            <link type="text/css" rel="stylesheet" href="{swagger_css_url}">
+            <link rel="shortcut icon" href="{swagger_favicon_url}">
+            <title>{title}</title>
+        </head>
+        <body>
+            <div id="swagger-ui"></div>
+            <script src="{swagger_js_url}"></script>
+            <script>
+                const ui = SwaggerUIBundle({{
+                    url: '{openapi_url}',
+    """
+    if swagger_extra_css_url is not None:
+        html = html.replace('</head>', f'<link type="text/css" rel="stylesheet" href="{swagger_extra_css_url}"></head>')
+    for key, value in current_swagger_ui_parameters.items():
+        html += f"{json.dumps(key)}: {json.dumps(jsonable_encoder(value))},\n"
+    if oauth2_redirect_url:
+        html += f"oauth2RedirectUrl: window.location.origin + '{oauth2_redirect_url}',"
+    html += """
+    presets: [
+        SwaggerUIBundle.presets.apis,
+        SwaggerUIBundle.SwaggerUIStandalonePreset
+        ],
+    })"""
+    if init_oauth:
+        html += f"""
+        ui.initOAuth({json.dumps(jsonable_encoder(init_oauth))})
+        """
+    html += """
+    </script>
+    </body>
+    </html>
+    """
+    return HTMLResponse(html)
+
+
+def create_docs(app: FastAPI):
+    swagger_ui_parameters = {
+        "displayOperationId": True,
+        "layout": "BaseLayout",
+        "showExtensions": True,
+        "showCommonExtensions": True,
+        "deepLinking": False,
+        "dom_id": "#swagger-ui",
+    }
+
+    @app.get("/docs", include_in_schema=True)
+    async def custom_swagger_html():
+        res = get_swagger_ui_html(
+            title=f'{app.title}: Swagger UI',
+            openapi_url=app.openapi_url,
+            swagger_favicon_url='/file=html/favicon.svg',
+            swagger_ui_parameters=swagger_ui_parameters,
+            swagger_extra_css_url='file=html/swagger.css',
+        )
+        # res = inject_css(html.content, 'html/swagger.css')
+        return res
+
+
+def create_redocs(app: FastAPI):
+    @app.get("/redocs", include_in_schema=True)
+    async def custom_redoc_html():
+        res = get_redoc_html(
+            title=f'{app.title}: ReDoc',
+            openapi_url=app.openapi_url,
+            redoc_favicon_url='/file=html/favicon.svg',
+        )
+        return res
+
+"""
+https://github.com/Amoenus/SwaggerDark/blob/master/SwaggerDark.css
+"""