rapidoc (Python)

Serves a RapiDoc API reference from a FastAPI or Starlette app: an interactive page for your OpenAPI document, with a console to try requests.

pip install rapidoc

from fastapi import FastAPI
from rapidoc.fastapi import setup_rapidoc

app = FastAPI(docs_url=None, redoc_url=None)

setup_rapidoc(app)

Open /docs. The page reads the app's own /openapi.json, and nothing is loaded from another site: the package carries the RapiDoc bundle.

FastAPI serves Swagger UI at /docs unless you create the app with docs_url=None. To keep Swagger UI, give RapiDoc another path: setup_rapidoc(app, path="/reference").

Options

These are the options of every RapiDoc integration, in Python naming.

Behind a proxy

When a proxy strips a path prefix, run the app with that prefix as its root_path (uvicorn app:app --root-path /api, or FastAPI(root_path="/api")). The page then uses the prefix for the bundle, the OpenAPI document and the OAuth return page, as FastAPI's own docs do.

Starlette

from rapidoc.starlette import setup_rapidoc is the same function, for any Starlette app. Starlette has no OpenAPI endpoint of its own, so pass spec_url or spec.

Notes

• Each release ships one version of rapidoc: rapidoc.rapidoc_version().

• The routes are left out of the app's OpenAPI document.

• OAuth sign-in returns to {path}/oauth-receiver.html, which the app serves on its own origin, also with assets="cdn".

• examples/app.py is a complete app.

• The package itself requires no framework; rapidoc.fastapi uses the Starlette that FastAPI installs. rapidoc.contract is the RapiDoc integration contract in plain Python, for building an integration for another framework.

Python 3.10 or later; Starlette 0.27 or later. MIT.