Bump

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

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

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

Использовать Bump просто, и он легко вписывается в ваш существующий рабочий процесс:

• Начните с создания бесплатной учетной записи на сайте Bump и настройте свой первый центр документации.

• Загрузите файл спецификации OpenAPI или AsyncAPI через веб-интерфейс или подключите его к вашему репозиторию на GitHub для автоматических обновлений.

• Подключите Bump к вашей системе непрерывной интеграции, чтобы документация обновлялась автоматически при внесении изменений в код.

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

• Настройте контроль доступа, чтобы решить, кто может просматривать вашу документацию. Вы можете сделать её публичной или пригласить конкретных членов команды и внешних пользователей.

• Используйте функцию API Explorer, чтобы пользователи могли тестировать ваш API прямо со страницы документации.

• Включите вебхуки, чтобы получать уведомления о изменениях API и держать вашу команду в курсе через Slack или другие инструменты.

• Автоматическая документация из файлов OpenAPI и AsyncAPI

• Журнал изменений API в реальном времени с обнаружением критических изменений

• Интерактивный исследователь API для тестирования конечных точек

• Центры документации для организации нескольких API

• Интеграция с GitHub и GitLab

• Пользовательские домены и варианты брендинга

• Управление ветками для разных версий

• Командное сотрудничество с контролем доступа

• Уведомления через вебхуки

• Ежемесячная рассылка по изменениям API