Create beautiful, customizable, interactive API documentation from OpenAPI Specification for Quart.
RapiDoc is fully customisable and small and fast. It comes with built in console to Try out the APIs. Supports authentication mechanism.
First, install Quart-Rapidoc
pip install Quart-Rapidoc
Next, add Rapidoc class to your code:
from quart import Quart
from quart_rapidoc import Rapidoc
app = Quart(__name__)
app.config['DOC_FILE'] = 'petstore.yml'
Rapidoc(app)
You can also customise the docs rendering:
from quart import Quart
from quart_rapidoc import Rapidoc
app = Quart(__name__)
conf = {
"allow-try": False,
"theme": "light",
"show-header": True,
}
app.config['RAPIDOC_CONFIG'] = conf
Rapidoc(app)
More of config parameters can be found here
Quart-Rapidoc
depends on recent versions of Quart, PyYaml.
Quart-Rapidoc
may work with older versions, but compatibility fixes for older versions will not be accepted, and
future changes may break compatibility in older versions.
Quart-Rapidoc is tested against Python 3.7+
versions.
Rapidoc: https://mrin9.github.io/RapiDoc/
Contributors of Quart-Rapidoc
Sriram G https://github.com/marirs