mirror of
https://github.com/fastapi/fastapi.git
synced 2026-03-30 20:54:03 -04:00
409264960e
* ✨ Allow disabling docs UIs by disabling openapi_url * 📝 Add docs for disabling OpenAPI and docs in prod or other environments * ✅ Add tests for disabling OpenAPI and docs
54 lines
1.7 KiB
Markdown
54 lines
1.7 KiB
Markdown
# Metadata and Docs URLs
|
|
|
|
You can customize several metadata configurations 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`:
|
|
|
|
```Python hl_lines="4 5 6"
|
|
{!../../../docs_src/metadata/tutorial001.py!}
|
|
```
|
|
|
|
With this configuration, the automatic API docs would look like:
|
|
|
|
<img src="/img/tutorial/metadata/image01.png">
|
|
|
|
## 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`:
|
|
|
|
```Python hl_lines="3"
|
|
{!../../../docs_src/metadata/tutorial002.py!}
|
|
```
|
|
|
|
If you want to disable the OpenAPI schema completely you can set `openapi_url=None`, that will also disable the documentation user interfaces that use it.
|
|
|
|
## 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:
|
|
|
|
```Python hl_lines="3"
|
|
{!../../../docs_src/metadata/tutorial003.py!}
|
|
```
|