Skip to main content

flask-swagger-ui

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

Included Swagger UI version: 5.32.13.

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.13.tar.gz (628.8 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.13-py3-none-any.whl (634.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flask_swagger_ui-5.32.13.tar.gz
  • Upload date:
  • Size: 628.8 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.13.tar.gz
Algorithm Hash digest
SHA256 90c9bdff70f8a4329db725771defe549cb32a2e775d9dd955d68e47dbe735939
MD5 6c1fe4c335b93420668433695803b710
BLAKE2b-256 0904e186b2f67f19d6a269140a7252e71367e7e9aec13d8272fce004b4d0d989

See more details on using hashes here.

Provenance

The following attestation bundles were made for flask_swagger_ui-5.32.13.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.13-py3-none-any.whl.

File metadata

File hashes

Hashes for flask_swagger_ui-5.32.13-py3-none-any.whl
Algorithm Hash digest
SHA256 a26841220ddb6968348a7cbdef92634bb1f5f80394f0e9b81cb5816fa8945422
MD5 c3882ee45625021f921c221ccf94f22f
BLAKE2b-256 a75e855ed1eabade7727d10a5e1170eb26340999c0e6d74c5eae92cc42c6e45e

See more details on using hashes here.

Provenance

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

This release

5.32.13 This release

2 files

5.32.12

2 files

5.32.11

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