swagger-ui-bundle-v2 5.31.0

Swagger UI bundled for usage with Python

swagger-ui-bundle-v2

Forked from spec-first/swagger_ui_bundle. We maintain this fork to keep the bundled Swagger UI up to date with newer releases.

This package contains the static files for swagger-ui as a python package.

Basic configuration options are templated with the Jinja2 templating language.

This package is intended to be webserver-agnostic, so it only includes the static files, and some very basic configuration.

Getting Started

You can import the swagger_ui_path from the swagger_ui_bundle package like so:

from swagger_ui_bundle import swagger_ui_path

You can easily serve up this directory as all static files to get the default swagger-ui distribution. Here’s an example in flask:

from swagger_ui_bundle import swagger_ui_path

from flask import Flask, Blueprint, send_from_directory, render_template

swagger_bp = Blueprint(
    'swagger_ui',
    __name__,
    static_url_path='',
    static_folder=swagger_ui_path,
    template_folder=swagger_ui_path
)

app = Flask(__name__, static_url_path='')
app.register_blueprint(swagger_bp, url_prefix='/ui')

if __name__ == "__main__":
    app.run()

You may wish to override some of the configuration variables. Included is a jinaj2 templated file where you can modify these parameters. You can add another route to render this template with your desired configuration like so:

SWAGGER_UI_CONFIG = {
    "openapi_spec_url": "https://petstore.swagger.io/v2/swagger.json"
}

@swagger_bp.route('/')
def swagger_ui_index():
    return render_template('index.j2', **SWAGGER_UI_CONFIG)

Have a look at example.py for a complete server for the Flask webserver.

Publishing

Test PyPI (tag = X.Y.Z, no v):

git tag 1.0.0
git push origin 1.0.0

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ swagger-ui-bundle-v2

Production: tag + push, then GitHub Releases → Create release for that tag → Publish.:

git tag 1.0.0
git push origin 1.0.0

pip install swagger-ui-bundle-v2

License

Since this is just repackaging swagger-ui releases, the license comes from the swagger ui project (https://github.com/swagger-api/swagger-ui).

All vendored code is published under the Apache 2.0 License.