This plugin updates the FastAPI app to host latest Swagger UI distribution.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for dantetemplar from gravatar.com dantetemplar

Unverified details

These details have not been verified by PyPI
Meta
Classifiers
Report project as malware

Project description

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

pip install fastapi-swagger

Basic Usage

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.

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 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).

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.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for dantetemplar from gravatar.com dantetemplar

Unverified details

These details have not been verified by PyPI
Meta
Classifiers

Release history Release notifications | RSS feed

This version

0.4.41

0.4.40

0.4.39

0.3.39

0.3.38

0.3.37

0.3.36

0.3.35

0.3.34

0.3.33

0.3.32

0.3.31

0.3.30

0.3.29

0.3.28

0.3.27

0.3.26

0.2.26

0.2.25

0.2.24

0.2.23

0.2.22

0.2.21

0.2.20

0.2.19

0.2.18

0.2.17

0.2.16

0.2.15

0.2.14

0.2.13

0.2.12

0.2.11

0.2.10

0.2.9

0.2.8

0.2.7

0.2.6

0.2.5

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0 yanked

Reason this release was yanked:

Too narrow dependency on fastapi==0.100

0.1.7 yanked

Reason this release was yanked:

Too narrow dependency on fastapi==0.100

0.1.6 yanked

Reason this release was yanked:

Too narrow dependency on fastapi==0.100

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastapi_swagger-0.4.41.tar.gz (448.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fastapi_swagger-0.4.41-py3-none-any.whl (452.1 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_swagger-0.4.41.tar.gz.

File metadata

  • Download URL: fastapi_swagger-0.4.41.tar.gz
  • Upload date:
  • Size: 448.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for fastapi_swagger-0.4.41.tar.gz
Algorithm Hash digest
SHA256 56ad8a9538b35cb8977b609b80d58b74c1b10c96ef1ed1cb6f41e556ba766ffe
MD5 d0e3a750a6708916c7207564f267eccd
BLAKE2b-256 ae0f60cde869d1ccbdbc410ddc3264cfe2012ea48202a5f7f308d0e3f6333752

See more details on using hashes here.

Provenance

The following attestation bundles were made for fastapi_swagger-0.4.41.tar.gz:

Publisher: listen-swagger-changes.yaml on dantetemplar/fastapi-swagger

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fastapi_swagger-0.4.41-py3-none-any.whl.

File metadata

File hashes

Hashes for fastapi_swagger-0.4.41-py3-none-any.whl
Algorithm Hash digest
SHA256 ae51ee9141242acfb1431fa880433f572ccf47e8ee94aeee2ea637a0a4065eb1
MD5 7d0a1d2332a11a8e5edb6bb02df1d665
BLAKE2b-256 1effafaf33830a350842b04d5df72415dc0aed6af794bcec25633d719d6fe34b

See more details on using hashes here.

Provenance

The following attestation bundles were made for fastapi_swagger-0.4.41-py3-none-any.whl:

Publisher: listen-swagger-changes.yaml on dantetemplar/fastapi-swagger

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page