API документация

Документерра позволяет автоматически создавать API-документацию из файлов OpenAPI в форматах .json или .yaml и размещать её вместе с вашими руководствами пользователей. Обновить API-документацию в соответствии с новыми исходными файлами очень просто - для этого достаточно нажать кнопку Обновить.

Если вы ищите информацию о функциональности API Документерры, пожалуйста, перейдите в раздел API Документерры.

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

Вот пример атоматически сгенерированной страницы API-документации на основе примера Swagger PetstoreАвтоматически сгенерированная страница из примера Swagger Petstore

Слева находится информация о запросе: его описание, параметры, схемы тела запроса и ответы. Справа — примеры запросов и ответов, а также интерактивная панель для тестирования запросов.

Интерактивная API-документация - тестирование запросов

Документерра генерирует интерактивную API-документацию на основе ваших спецификаций. Это означает, что ваши читатели могут тестировать API-запросы прямо из браузера, используя кнопку Test Request.Кнопка Try Out в автоматически сгенерированной странице

После нажатия кнопки вам будет предложено указать данные для аутентификации, параметры, заголовки и т.д., если это необходимо, и отправить тестовый запрос. Для того чтобы отправить запрос нажмите кнопку Send.Пример окна, которое вы увидите после нажатия кнопки "Test Request"

Больше информации об этом вы можете найти здесь: Попробуйте интерактивную API-документацию.