tiangolo.fastapi/docs/tutorial/application-configuration.md

There are several things that you can configure in your FastAPI application.

Title, description, and version

You can set the:

• Title: used as your API's title/name, in OpenAPI and the automatic API docs UIs.
• Description: the description of your API, in OpenAPI and the automatic API docs UIs.
• Version: the version of your API, e.g. v2 or 2.5.0.
  • Useful for example if you had a previous version of the application, also using OpenAPI.

To set them, use the parameters title, description, and version:

{!./src/application_configuration/tutorial001.py!}

With this configuration, the automatic API docs would look like:

OpenAPI URL

By default, the OpenAPI schema is served at /openapi.json.

But you can configure it with the parameter openapi_url.

For example, to set it to be served at /api/v1/openapi.json:

{!./src/application_configuration/tutorial002.py!}

If you want to disable the OpenAPI schema completely you can set openapi_url=None.

Docs URLs

You can configure the two documentation user interfaces included:

• Swagger UI: served at /docs.
  • You can set its URL with the parameter docs_url.
  • You can disable it by setting docs_url=None.
• ReDoc: served at /redoc.
  • You can set its URL with the parameter redoc_url.
  • You can disable it by setting redoc_url=None.

For example, to set Swagger UI to be served at /documentation and disable ReDoc:

{!./src/application_configuration/tutorial003.py!}