Одним из очень важных особенностей фреймворка FastAPI является его способность автоматически генерировать интерактивную документацию API. В этом разделе мы рассмотрим, что это значит и как получить доступ к вашей автоматически сгенерированной документации. 

По умолчанию FastAPI включает поддержку пользовательского интерфейса Swagger и Redoc.

Спецификация OpenAPI

FastAPI построен вокруг OpenAPI, широко используемый отраслевой стандарт для описания RESTful API. Спецификация позволяет изучать и понимать возможности RESTful API без необходимости доступа к его исходному коду, документации по продукту или любым другим техническим рекомендациям.

Определение OpenAPI для продукта API существует как стандартный документ JSON или YAML, который описывает информацию об API, его номере версии, внешних серверах и конечных точках. Пути также перечисляют методы HTTP, которые должны выполняться на ресурсах API вместе с их ответами.

Если мы хотим посмотреть, как выглядит необработанная схема OpenAPI, перейдем по адресу http://127.0.0.1:8000/openapi.json

Мы видим что у нас всего лишь один путь("/"), который принимает GET запрос, это функция welcome().  Инструменты Swagger и Redoc фактически переводят JSON-представление кода API. Они используют определенный код JavaScript и CSS для элегантного представления необработанного формата JSON, в котором присутствует схема API.

Существует множество инструментов генерации схемы API, подобных Swagger и Redoc. Вы также можете легко настроить FastAPI для использования любого из этих инструментов. Но в данном разделе мы рассмотрим лишь встроенные интерфейсы документации.