Интерактивная API-документация в Документерре предоставляет возможность тестирования API-запросов непосредственно из браузера с использованием функции Test Request. В данном примере рассматривается автоматически сгенерированная страница API-документации на основе стандартного примера Swagger Petstore.
Как это работает?
Когда ваша API-документация опубликована, пользователи могут нажать кнопку Test Request:
После этого можно указать заголовки запроса, параметры и другие необходимые данные, а также выбрать адрес сервера, на который будет отправлен API-вызов, если доступно несколько вариантов. Затем нажать кнопку Send:
В результате Документерра отправляет API запрос, ответ отображается в том же окне:
Авторизация
Если вызов API требует аутентификации, пользователи могут указать необходимые данные в разделе Authentication и выбрать один или несколько из доступных типов аутентификации.