Skip to main content

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.

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.55.tar.gz (451.0 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.55-py3-none-any.whl (454.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fastapi_swagger-0.4.55.tar.gz
Algorithm Hash digest
SHA256 7f836fe859884dd807d42af8ea87e2e7a1e2fbf1dc7bfb537c3523c826ff1ac3
MD5 c0d3e09857329f6554fab54f5c43c021
BLAKE2b-256 b74d5e964ec33201e5f1a759b384bc59ab329a6d97d035a5aad093fe3935081c

See more details on using hashes here.

Provenance

The following attestation bundles were made for fastapi_swagger-0.4.55.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.55-py3-none-any.whl.

File metadata

File hashes

Hashes for fastapi_swagger-0.4.55-py3-none-any.whl
Algorithm Hash digest
SHA256 3213a06d0a43daedac72e2dad2454c329fd2a9ca2e1c8f6c398d4816b8782fb9
MD5 d86621739a39cfc7140fac201d66a6f7
BLAKE2b-256 116dd42c84be91009229911c602bf96b863a9caa7dec2e67a941bfc2e5e61555

See more details on using hashes here.

Provenance

The following attestation bundles were made for fastapi_swagger-0.4.55-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.

Release history Release notifications | RSS feed

0.4.59

2 files

0.4.58

2 files

0.4.57

2 files

0.4.56

2 files

This release

0.4.55 This release

2 files

0.4.54

2 files

0.4.53

2 files

0.4.52

2 files

0.4.51

2 files

0.4.50

2 files

0.4.49

2 files

0.4.48

2 files

0.4.47

2 files

0.4.46

2 files

0.4.45

2 files

0.4.44

2 files

0.4.43

2 files

0.4.42

2 files

0.4.41

2 files

0.4.40

2 files

0.4.39

2 files

0.3.39

2 files

0.3.38

2 files

0.3.37

2 files

0.3.36

2 files

0.3.35

2 files

0.3.34

2 files

0.3.33

2 files

0.3.32

2 files

0.3.31

2 files

0.3.30

2 files

0.3.29

2 files

0.3.28

2 files

0.3.27

2 files

0.3.26

2 files

0.2.26

2 files

0.2.25

2 files

0.2.24

2 files

0.2.23

2 files

0.2.22

2 files

0.2.21

2 files

0.2.20

2 files

0.2.19

2 files

0.2.18

2 files

0.2.17

2 files

0.2.16

2 files

0.2.15

2 files

0.2.14

2 files

0.2.13

2 files

0.2.12

2 files

0.2.11

2 files

0.2.10

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.7

2 files

0.1.6

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page