Registry / web-framework / swagger-ui-bundle

swagger-ui-bundle

library1.1.0pypypi✓ verified 30d ago

Swagger UI bundle provides the static files for Swagger UI, making it easy to integrate into Python web frameworks without needing to manage frontend assets. It ships a specific version of Swagger UI, which is then served by the user's web application. The current version is 1.1.0. Release cadence is infrequent, typically aligning with significant upstream Swagger UI updates or maintenance.

web-framework

pip install swagger-ui-bundle Flask Jinja2

github ↗package ↗

INSTALL

IMPORT

SIG · SWAGGER-UI-BUNDLE

swagger-ui-bundle

web-frameworkpythonv1.1.0

Install

2.3s avg

Import

55ms

Disk

29MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.1.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.056s · 30.7MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 2.3s · import 0.054s · 31MB

29MB installed

● package 29MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

swagger_ui_path

✓ from swagger_ui_bundle import swagger_ui_path

✗ from swagger_ui_bundle import get_swagger_ui_bundle_path

The function name changed to a simpler variable representing the path.

This quickstart demonstrates how to use `swagger_ui_path` with Flask to serve the Swagger UI assets and display an API documentation page. The core idea is to expose the directory returned by `swagger_ui_path` via your web framework's static file serving mechanism and then reference these files in an HTML template.

import os from flask import Flask, render_template_string, send_from_directory from swagger_ui_bundle import swagger_ui_path app = Flask(__name__) # 1. Route to serve Swagger UI static files @app.route('/swagger-ui-assets/<path:filename>') def serve_swagger_ui_assets(filename): return send_from_directory(swagger_ui_path, filename) # 2. Route to serve your OpenAPI specification (example) @app.route('/openapi.json') def serve_openapi_spec(): return { "openapi": "3.0.0", "info": {"title": "Sample API", "version": "1.0.0"}, "paths": { "/hello": { "get": { "summary": "Says hello", "responses": {"200": {"description": "A greeting"}} } } } } # 3. Route to display the Swagger UI page @app.route('/docs/') def show_swagger_ui(): html_content = ''' <!DOCTYPE html> <html> <head> <title>Swagger UI</title> <link rel="stylesheet" type="text/css" href="/swagger-ui-assets/swagger-ui.css"> </head> <body> <div id="swagger-ui"></div> <script src="/swagger-ui-assets/swagger-ui-bundle.js"></script> <script src="/swagger-ui-assets/swagger-ui-standalone-preset.js"></script> <script> window.onload = function() { SwaggerUIBundle({ url: "/openapi.json", // URL to your OpenAPI spec dom_id: '#swagger-ui', presets: [ SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset ], layout: "StandaloneLayout" }); }; </script> </body> </html> ''' return render_template_string(html_content) if __name__ == '__main__': # Run this example after installing Flask: pip install Flask print(f"Swagger UI bundle path: {swagger_ui_path}") print("Go to http://127.0.0.1:5000/docs/ to see the Swagger UI.") app.run(debug=True)

Debug

Known issues

breakingVersion 1.1.0 includes a major update to the bundled Swagger UI (from 3.x to 4.x). While the Python API `swagger_ui_path` remains stable, any custom JavaScript or CSS directly interacting with or relying on specific internal structures of the Swagger UI frontend might break.

fix

Thoroughly test your Swagger UI integration after upgrading to 1.1.0 or newer. Review Swagger UI's own changelogs for any breaking changes in its frontend assets if you have custom scripts.

affects: Prior to 1.1.0

gotchaThis library only provides the filesystem path to the Swagger UI assets. It does not include a built-in web server or a direct integration with any specific web framework. You must explicitly configure your web framework (e.g., Flask, Django, FastAPI) to serve these static files.

fix

Follow your web framework's documentation for serving static files from a specific directory, typically by setting up a route that uses `send_from_directory` or similar.

affects: All versions

gotchaThe version of Swagger UI bundled with this library may not always be the absolute latest upstream version. `swagger-ui-bundle` updates its bundled Swagger UI only when a new version of the Python package is released.

fix

Check the `swagger-ui-bundle` release notes (e.g., on GitHub or PyPI) to determine which Swagger UI version is included. If you require the absolute latest Swagger UI features or fixes, you might need to bundle it manually or wait for an update to this package.

affects: All versions

Upgrade

Version history

1.1.0latest on PyPI · released Nov 1, 2023

Audit

Dependencies

No dependency data recorded yet.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/spec-first/swagger_ui_bundle ↗

packagehttps://pypi.org/project/swagger-ui-bundle/ ↗