Skip to main content

flask-swagger-ui

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

Included Swagger UI version: 5.32.11.

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.11.tar.gz (626.7 kB view details)

Uploaded Source

Built Distribution

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

flask_swagger_ui-5.32.11-py3-none-any.whl (632.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for flask_swagger_ui-5.32.11.tar.gz
Algorithm Hash digest
SHA256 e00a0c8f925eacfbfdd1e12f1b53d07743f286cd6ccf0c1e0eb074b66b2b9426
MD5 bd29ce9e47e8652052ce475bcb256ef7
BLAKE2b-256 195c5f4890fdbed3b230140621e534cf38e1367a5ac5b059ea80f7055bb7276c

See more details on using hashes here.

Provenance

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

File details

Details for the file flask_swagger_ui-5.32.11-py3-none-any.whl.

File metadata

File hashes

Hashes for flask_swagger_ui-5.32.11-py3-none-any.whl
Algorithm Hash digest
SHA256 930b0450625fc862ceab747f1b4f297c075e87bbc89ef71685578b2e7e476014
MD5 afa72d5d032c828825b49ed42e231da8
BLAKE2b-256 3052dda5fbe5798117af30eb1bcda2c64f26756de56c7c895b8749b85996c336

See more details on using hashes here.

Provenance

The following attestation bundles were made for flask_swagger_ui-5.32.11-py3-none-any.whl:

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.

Release history Release notifications | RSS feed

5.32.14

2 files

5.32.13

2 files

5.32.12

2 files

This release

5.32.11 This release

2 files

5.32.9

2 files

5.32.8

2 files

5.32.6

2 files

5.32.5

2 files

5.32.4

2 files

5.32.2

2 files

5.32.1.post2

2 files

5.21.0

2 files

4.11.1

2 files

3.36.0

1 file

3.25.0

1 file

3.20.9

1 file

3.18.0

1 file

3.6.0

1 file

3.0.12

1 file

0.0.3

1 file

0.0.2

1 file

0.0.1

1 file

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