fastapi-swagger 0.1.6__tar.gz

fastapi_swagger-0.1.6/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ruslan Bel'kov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastapi_swagger-0.1.6/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.1
+Name: fastapi-swagger
+Version: 0.1.6
+Summary: 
+Home-page: https://github.com/dantetemplar/fastapi-swagger
+License: MIT
+Author: Ruslan Bel'kov
+Author-email: ruslan.belckov@yandex.ru
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: fastapi (==0.100)
+Project-URL: Repository, https://github.com/dantetemplar/fastapi-swagger
+Description-Content-Type: text/markdown
+
+# FastAPI Swagger Plugin
+
+This plugin updates the FastAPI app to include a latest Swagger UI distribution. Also, it works locally and does not
+depend on the @tiangolo domains and cdns.
+
+## Why?
+
+The FastAPI already includes a Swagger UI. However, author updates swagger not so often. Moreover he uses his own
+hosts for the resources, and they are not always available (especially in Russia). This plugin allows to use the latest
+Swagger UI distribution and host it inside your app.
+
+## Usage
+
+### Installation
+
+```bash
+pip install fastapi_swagger
+```
+
+### Basic Usage
+
+```python
+from fastapi import FastAPI
+from fastapi_swagger import patch_fastapi
+
+app = FastAPI(docs_url=None, swagger_ui_oauth2_redirect_url=None)  # docs url will be at /docs
+
+patch_fastapi(app)
+```
+
+## How it works?
+
+How it was before:
+FastAPI uses the `get_swagger_ui_html` function to render the Swagger UI under the hood.
+
+```python
+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_favicon_url: str = "https://fastapi.tiangolo.com/img/favicon.png",
+        oauth2_redirect_url: Optional[str] = None,
+        init_oauth: Optional[Dict[str, Any]] = None,
+        swagger_ui_parameters: Optional[Dict[str, Any]] = None,
+) -> HTMLResponse:
+    ...
+```
+
+How it is now:
+
+Actually, we just copy the Swagger UI distribution from
+the [GitHub releases](https://github.com/swagger-api/swagger-ui/releases) to the `fastapi_swagger` package, and serve it
+from your app.
+Patch creates several additional routes with the Swagger UI resources and one route for docs page (btw, using same
+`get_swagger_ui_html` function).
+
+```python
+def patch_fastapi(
+        app: FastAPI,
+        docs_url: str = "/docs",
+        *,
+        title: Optional[str],
+        swagger_js_url: str = "/swagger/swagger-ui-bundle.js",  # relative path from app root
+        swagger_css_url: str = "/swagger/swagger-ui.css",  # relative path from app root
+        swagger_favicon_url: str = "/swagger/favicon-32x32.png",  # relative path from app root
+        oauth2_redirect_url: Optional[str] = None,
+        init_oauth: Optional[Dict[str, Any]] = None,
+        swagger_ui_parameters: Optional[Dict[str, Any]] = None,
+):
+    ...
+
+
+patch_fastapi(app)
+# Now there are additional routes /swagger/swagger-ui-bundle.js, /swagger/swagger-ui.css, /swagger/favicon-32x32.png and /docs
+# They all are not dependent on the external resources.
+```
+

fastapi_swagger-0.1.6/README.md

@@ -0,0 +1,78 @@
+# FastAPI Swagger Plugin
+
+This plugin updates the FastAPI app to include a latest Swagger UI distribution. Also, it works locally and does not
+depend on the @tiangolo domains and cdns.
+
+## Why?
+
+The FastAPI already includes a Swagger UI. However, author updates swagger not so often. Moreover he uses his own
+hosts for the resources, and they are not always available (especially in Russia). This plugin allows to use the latest
+Swagger UI distribution and host it inside your app.
+
+## Usage
+
+### Installation
+
+```bash
+pip install fastapi_swagger
+```
+
+### Basic Usage
+
+```python
+from fastapi import FastAPI
+from fastapi_swagger import patch_fastapi
+
+app = FastAPI(docs_url=None, swagger_ui_oauth2_redirect_url=None)  # docs url will be at /docs
+
+patch_fastapi(app)
+```
+
+## How it works?
+
+How it was before:
+FastAPI uses the `get_swagger_ui_html` function to render the Swagger UI under the hood.
+
+```python
+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_favicon_url: str = "https://fastapi.tiangolo.com/img/favicon.png",
+        oauth2_redirect_url: Optional[str] = None,
+        init_oauth: Optional[Dict[str, Any]] = None,
+        swagger_ui_parameters: Optional[Dict[str, Any]] = None,
+) -> HTMLResponse:
+    ...
+```
+
+How it is now:
+
+Actually, we just copy the Swagger UI distribution from
+the [GitHub releases](https://github.com/swagger-api/swagger-ui/releases) to the `fastapi_swagger` package, and serve it
+from your app.
+Patch creates several additional routes with the Swagger UI resources and one route for docs page (btw, using same
+`get_swagger_ui_html` function).
+
+```python
+def patch_fastapi(
+        app: FastAPI,
+        docs_url: str = "/docs",
+        *,
+        title: Optional[str],
+        swagger_js_url: str = "/swagger/swagger-ui-bundle.js",  # relative path from app root
+        swagger_css_url: str = "/swagger/swagger-ui.css",  # relative path from app root
+        swagger_favicon_url: str = "/swagger/favicon-32x32.png",  # relative path from app root
+        oauth2_redirect_url: Optional[str] = None,
+        init_oauth: Optional[Dict[str, Any]] = None,
+        swagger_ui_parameters: Optional[Dict[str, Any]] = None,
+):
+    ...
+
+
+patch_fastapi(app)
+# Now there are additional routes /swagger/swagger-ui-bundle.js, /swagger/swagger-ui.css, /swagger/favicon-32x32.png and /docs
+# They all are not dependent on the external resources.
+```

fastapi_swagger-0.1.6/fastapi_swagger/__init__.py

@@ -0,0 +1,3 @@
+__all__ = ["patch_fastapi"]
+
+from .main import patch_fastapi

fastapi_swagger-0.1.6/fastapi_swagger/main.py

@@ -0,0 +1,88 @@
+from importlib import resources
+from typing import Optional, Dict, Any
+
+from fastapi import FastAPI, Response, Request
+from fastapi.openapi.docs import get_swagger_ui_html
+from starlette.responses import RedirectResponse
+
+
+def patch_fastapi(
+    app: FastAPI,
+    docs_url: str = "/docs",
+    redirect_from_root_to_docs: bool = True,
+    *,
+    title: Optional[str],
+    swagger_js_url: str = "/swagger/swagger-ui-bundle.js",  # relative path from app root
+    swagger_css_url: str = "/swagger/swagger-ui.css",  # relative path from app root
+    swagger_favicon_url: str = "/swagger/favicon-32x32.png",  # relative path from app root
+    oauth2_redirect_url: Optional[str] = None,
+    init_oauth: Optional[Dict[str, Any]] = None,
+    swagger_ui_parameters: Optional[Dict[str, Any]] = None,
+):
+    """
+    Patch FastAPI app to serve Swagger UI using fastapi_swagger plugin
+
+    :param app: FastAPI app
+    :param docs_url: URL to serve Swagger UI
+    :param redirect_from_root_to_docs: Redirect from root to Swagger UI (default: True)
+    :param title: Title of Swagger UI page (default: f"{app.title} - Swagger UI") - html title
+    :param swagger_js_url: Where to serve Swagger UI JS bundle
+    :param swagger_css_url: Where to serve Swagger UI CSS
+    :param swagger_favicon_url: Where to serve Swagger UI favicon image - html icon
+    :param swagger_ui_parameters: Parameters for Swagger UI
+     (default: {"tryItOutEnabled": True, "persistAuthorization": True, "filter": True})
+    :param init_oauth: OAuth2 configuration
+    :param oauth2_redirect_url: OAuth2 redirect URL
+    """
+    if redirect_from_root_to_docs:
+
+        @app.get("/", include_in_schema=False)
+        async def redirect_to_docs(request: Request):
+            return RedirectResponse(url=request.url_for("swagger_ui_html"))
+
+    @app.get(docs_url, tags=["Swagger"], include_in_schema=False)
+    async def swagger_ui_html(request: Request):
+        nonlocal swagger_ui_parameters, title, oauth2_redirect_url
+        root_path = request.scope.get("root_path", "").rstrip("/")
+        openapi_url = root_path + app.openapi_url
+        _swagger_js_url = request.url_for("swagger_ui_bundle_js")
+        _swagger_css_url = request.url_for("swagger_ui_css")
+        _swagger_favicon_url = request.url_for("swagger_favicon_png")
+        if swagger_ui_parameters is None:
+            swagger_ui_parameters = {
+                "tryItOutEnabled": True,
+                "persistAuthorization": True,
+                "filter": True,
+            }
+        return get_swagger_ui_html(
+            openapi_url=openapi_url,
+            title=title or f"{app.title} - Swagger UI",
+            swagger_js_url=str(_swagger_js_url),
+            swagger_css_url=str(_swagger_css_url),
+            swagger_favicon_url=str(_swagger_favicon_url),
+            oauth2_redirect_url=oauth2_redirect_url,
+            init_oauth=init_oauth,
+            swagger_ui_parameters=swagger_ui_parameters,
+        )
+
+    @app.get(swagger_js_url, tags=["Swagger"], include_in_schema=False)
+    async def swagger_ui_bundle_js() -> Response:
+        with resources.open_binary(
+            "fastapi_swagger.resources", "swagger-ui-bundle.js"
+        ) as f:
+            _ = f.read()
+            return Response(content=_, media_type="application/javascript")
+
+    @app.get(swagger_css_url, tags=["Swagger"], include_in_schema=False)
+    async def swagger_ui_css() -> Response:
+        with resources.open_binary("fastapi_swagger.resources", "swagger-ui.css") as f:
+            _ = f.read()
+            return Response(content=_, media_type="text/css")
+
+    @app.get(swagger_favicon_url, tags=["Swagger"], include_in_schema=False)
+    async def swagger_favicon_png() -> Response:
+        with resources.open_binary(
+            "fastapi_swagger.resources", "favicon-32x32.png"
+        ) as f:
+            _ = f.read()
+            return Response(content=_, media_type="image/png")