flask-swagger-ui

Simple Flask blueprint for adding Swagger UI to your flask application.

Included Swagger UI version: 5.32.12.

This project is automatically updated to latest Swagger UI version on a weekly basis, but is otherwise not actively maintained.

Installation

pip install flask-swagger-ui

Usage

Example application:

from flask import Flask
from flask_swagger_ui import get_swaggerui_blueprint

app = Flask(__name__)


SWAGGER_URL = '/api/docs'  # URL for exposing Swagger UI (without trailing '/')
API_URL = 'https://petstore.swagger.io/v2/swagger.json'  # Our API url (can of course be a local resource)

# Call factory function to create our blueprint
swaggerui_blueprint = get_swaggerui_blueprint(
    SWAGGER_URL,  # Swagger UI static files will be mapped to '{SWAGGER_URL}/dist/'
    API_URL,
    config={  # Swagger UI config overrides
        'app_name': "Test application"
    },
    # oauth_config={  # OAuth config. See https://github.com/swagger-api/swagger-ui#oauth2-configuration .
    #    'clientId': "your-client-id",
    #    'clientSecret': "your-client-secret-if-required",
    #    'realm': "your-realms",
    #    'appName': "your-app-name",
    #    'scopeSeparator': " ",
    #    'additionalQueryStringParams': {'test': "hello"}
    # }
)

app.register_blueprint(swaggerui_blueprint)

app.run()

# Now point your browser to localhost:5000/api/docs/

Configuration

The blueprint supports overloading all Swagger UI configuration options that can be JSON serialized. See https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#parameters for options.

Plugins and function parameters are not supported at this time.

OAuth2 parameters can be found at https://github.com/swagger-api/swagger-ui#oauth2-configuration .

Download files

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

Source Distribution

flask_swagger_ui-5.32.12.tar.gz (627.3 kB view details)

Uploaded Aug 3, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

flask_swagger_ui-5.32.12-py3-none-any.whl (632.6 kB view details)

Uploaded Aug 3, 2026 Python 3

File details

Details for the file flask_swagger_ui-5.32.12.tar.gz.

File metadata

Download URL: flask_swagger_ui-5.32.12.tar.gz
Upload date: Aug 3, 2026
Size: 627.3 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for flask_swagger_ui-5.32.12.tar.gz
Algorithm	Hash digest
SHA256	`51673e53b52d5d6b88469b02c3132bc16f05541a779abaabb88adf77452dd8c7`
MD5	`ce177934d377d28d82cff8747c7631ec`
BLAKE2b-256	`f9779c5c72892cb9bf13aa80dfdca168a5f3a19cb5a2a761feb7f98ba61b0541`

See more details on using hashes here.

Provenance

The following attestation bundles were made for flask_swagger_ui-5.32.12.tar.gz:

Publisher: release.yml on sveint/flask-swagger-ui

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: flask_swagger_ui-5.32.12.tar.gz
- Subject digest: 51673e53b52d5d6b88469b02c3132bc16f05541a779abaabb88adf77452dd8c7
- Sigstore transparency entry: 2334780840
- Sigstore integration time: Aug 3, 2026
Source repository:
- Permalink: sveint/flask-swagger-ui@012a6e106347e5f20c6a190a7d06cb0b614aa7ec
- Branch / Tag: refs/heads/main
- Owner: https://github.com/sveint
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@012a6e106347e5f20c6a190a7d06cb0b614aa7ec
- Trigger Event: schedule