Registry / devops / flask-openapi3-rapidoc

flask-openapi3-rapidoc

library9.3.8pypypiunverified

Provides RapiDoc UI for Flask-OpenAPI3. Current version is 9.3.8. Released as part of the flask-openapi3-plugins monorepo, with frequent updates aligned with Flask-OpenAPI3 releases.

devops

pip install flask-openapi3-rapidoc

github ↗homepage ↗

INSTALL

IMPORT

SIG · FLASK-OPENAPI3-RAP

flask-openapi3-rapidoc

devopspythonv9.3.8

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

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

RapidocUI

✓ from flask_openapi3_rapidoc import RapidocUI

✗ from flask_openapi3_rapidoc import RapidocUI

Minimal setup integrating RapiDoc UI with Flask-OpenAPI3.

from flask import Flask from flask_openapi3 import OpenAPI from flask_openapi3_rapidoc import RapidocUI app = Flask(__name__) api = OpenAPI(app, info={"title": "Demo API", "version": "1.0.0"}) RapidocUI(api) @app.get('/') def hello(): return {"message": "hello world"} if __name__ == '__main__': app.run()

Debug

Known issues

deprecatedThe old import from 'flask_openapi3_rapidoc' may change with major version bumps. Check compatibility with your installed version.

fix

Use the import as shown in the quickstart. If upgrading from a very old version, refer to changelog.

affects: >=5.0.0

gotchaEnsure you instantiate RapidocUI after creating the OpenAPI instance, otherwise the UI may not be registered correctly.

fix

Instantiate RapidocUI(api) after api = OpenAPI(app, ...).

affects: all

gotchaRapidocUI requires 'flask-openapi3' to be installed; missing it will cause an ImportError at runtime.

fix

Install flask-openapi3 via pip.

affects: all

Upgrade

Version history

9.3.8latest on PyPI · released Oct 12, 2024

Audit

Dependencies

flask-openapi3requiredRequired to use the RapiDoc UI plugin.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/luolingchun/flask-openapi3-plugins/tree/master/flask-openapi3-rapidoc ↗

homepagehttps://github.com/luolingchun/flask-openapi3-plugins/tree/master/flask-openapi3-rapidoc ↗