Skip to main content

swagger_ui_bundle

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

# or if you need a specific version
from swagger_ui_bundle import swagger_ui_2_path
from swagger_ui_bundle import swagger_ui_3_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.

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 by SmartBear Software under the Apache 2.0 License.

Metadata

Release files for swagger-ui-bundle 0.0.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for swagger-ui-bundle 0.0.8
File Size Uploaded Provenance Actions
swagger_ui_bundle-0.0.8.tar.gz 3.7 MB Without provenance Details for swagger_ui_bundle-0.0.8.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for swagger-ui-bundle 0.0.8
File Interpreter ABI Platform Actions
swagger_ui_bundle-0.0.8-py3-none-any.whl Python 3 none any Details for swagger_ui_bundle-0.0.8-py3-none-any.whl

Total release size: 7.5 MB

Release files / swagger_ui_bundle-0.0.8.tar.gz

Download URL swagger_ui_bundle-0.0.8.tar.gz
Size 3.7 MB
Tags Source
SHA-256 checksum
How to use checksums
f5691167f2e9f73ecbe8229a89454ae5ea958f90bb0d4583ed7adaae598c4122
BLAKE2b-256 checksum
How to use checksums
401e75dd5ccc4bbf1086f3a46d52ac7766d5766836874c2de49351f5d4cccbed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.7

Release files / swagger_ui_bundle-0.0.8-py3-none-any.whl

Download URL swagger_ui_bundle-0.0.8-py3-none-any.whl
Size 3.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
f5255f786cde67a2638111f4a7d04355836743198a83c4ecbe815d9fc384b0c8
BLAKE2b-256 checksum
How to use checksums
bff34d370b25c6a23f44d6e6d538ff42c13f897b6cf71e7b684aa6aa9779d800
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.7

Security for swagger-ui-bundle 0.0.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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