Skip to content
masterclass Buddy
Start learning

FastAPI · Concept

OpenAPI docs

get_swagger_ui_html creates the HTML page for FastAPI's Swagger UI documentation. Pass the OpenAPI schema URL and a page title, then use the result in a custom route if needed.

Last updated

Syntax

get_swagger_ui_html(*, openapi_url, title, swagger_js_url="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js", swagger_css_url="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css", swagger_favicon_url="https://fastapi.tiangolo.com/img/favicon.png", oauth2_redirect_url=None, init_oauth=None, swagger_ui_parameters=None)

In-depth API docs are only for subscribers: parameters, examples, common mistakes and interview practice.

Subscribe
  • FastAPI
  • OpenAPI
  • Swagger UI
  • ReDoc
  • app.openapi_url
  • docs_url

Source: OpenAPI docs - FastAPI. Checked 2026-11-03.