Атрибут redoc_url
Атрибут redoc_url применяется к приложению
FastAPI и хранит строку с адресом страницы
документации ReDoc. По умолчанию он равен
'/redoc'. Значение можно задать при создании
приложения через одноимённый параметр конструктора
FastAPI. Если передать None, страница
ReDoc отключается.
Синтаксис
app.redoc_url
Пример
Давайте посмотрим значение атрибута по умолчанию:
from fastapi import FastAPI
app = FastAPI()
res = app.redoc_url
Результат выполнения кода:
"/redoc"
Пример
Давайте зададим собственный адрес для ReDoc
через параметр redoc_url:
from fastapi import FastAPI
app = FastAPI(redoc_url='/documentation')
res = app.redoc_url
Результат выполнения кода:
"/documentation"
Пример
Давайте отключим страницу ReDoc, передав
None:
from fastapi import FastAPI
app = FastAPI(redoc_url=None)
res = app.redoc_url
Результат выполнения кода:
None
Смотрите также
-
атрибут
docs_url,
который задаёт адрес страницы Swagger UI -
атрибут
openapi_url,
который задаёт адрес OpenAPI-схемы приложения -
метод
openapi,
который возвращает OpenAPI-схему приложения -
класс
FastAPI,
который создаёт приложение FastAPI
