2 варианта документации в FastAPI

Форматы API-документации

Кроме стандартной Swagger-документации, которая идёт по умолчанию и доступна по адресу /docs, есть также возможность использовать другие варианты представления API-документации.

Первый вариант — это OpenAPI JSON. Перейдя по соответствующей ссылке, можно получить доступ к документации в формате JSON. Это бывает удобно, если нужно передать её в какие-то сторонние системы, которые будут программным образом обрабатывать ваш API. Например, можно отправить этот файл искусственному интеллекту, чтобы он знал, что собой представляет API вашего проекта, и мог с ней работать.

Альтернативный интерфейс ReDoc

Кроме того, есть такой формат, как ReDoc. Это немного другой интерфейс для просмотра документации, который тоже доступен по ссылке /redoc. Вы также можете его использовать.

Такие возможности по представлению API-документации доступны по умолчанию во фреймворке FastAPI.