Redoc

Redoc - это еще один инструмент с открытым исходным кодом от Redocly, который генерирует документацию API из определений OpenAPI. Он имеет панель поиска, навигационное меню, документацию и примеры запросов и ответов.

Перейдем по адресу http://127.0.0.1:8000/redoc, чтобы отобразить документацию Redoc.

В данном интерфейсы мы также можем отслеживать все возможности нашего API.

И последним шагом в этом разделе, давайте рассмотрим, как мы можем удалить генерацию документации при инициализации приложения. Например, чтобы отключить Swagger UI, можем установить docs_url=None, а чтобы отключить Redoc, установить redoc_url=None.

from fastapi import FastAPI

app = FastAPI(
    docs_url=None,  # Disable docs (Swagger UI)
    redoc_url=None,  # Disable redoc
)


@app.get("/")
async def welcome() -> dict:
    return {"message": "Hello World"}

Но нам это делать не нужно, так как далее по курсу мы еще много раз будем обращаться к схеме API, и научимся полноценно работать с ней.