Swagger UI

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

Пользовательский интерфейс Swagger читает документ OpenAPI, который FastAPI создает из ваших конечных точек. Затем он генерирует список этих конечных точек, их методов и параметров HTTP, а также операций, доступных для выполнения. Это также позволяет тестировать конечные точки в пользовательском интерфейсе Swagger.

Каждое приложение FastAPI имеет страницу пользовательского интерфейса Swagger, сгенерированную из конечных точек API. Страница по умолчанию для документации FastAPI Swagger - /docs/. Из прошлого раздела у нас есть приложение выводящее "Hello World", запустим его и перейдем по адресу http://127.0.0.1:8000/docs/ и посмотрим документацию:

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

Развернем наш первый GET параметр, соответствующий функции welcome(), нажав на стрелку справа. Далее нажмем кнопку "Try it out" и посмотрим, есть ли какие-либо параметры, определенные для функции. Поскольку их нет, список параметров пуст.

Нажмите кнопку "Execute". И мы увидим всю необходимую информацию, такую как тип запроса, время запроса, и что возвращает данный запрос.

На данный момент у нас простейшая функция, но в следующем разделе мы продолжим работу с документацией, и узнаем как передаются данные и выполняются запросы.