Bump — сучасна платформа для документації API, яка перетворює специфікації OpenAPI та AsyncAPI на красиву, завжди оновлену документацію з автоматичним відстеженням змін.
Що таке Bump
Bump — це інструмент для документації API, який створює гарну документацію з ваших файлів OpenAPI або AsyncAPI. Замість того, щоб писати документацію вручну, ви надаєте файл специфікації API, а Bump генерує повний вебсайт документації з усіма кінцевими точками, параметрами та прикладами.
Платформа працює як центр для всієї вашої документації API. Вона може розміщувати кілька документів API в одному місці, що полегшує розробникам пошук необхідної інформації. Bump відстежує кожну зміну, яку ви вносите до свого API, і автоматично створює детальний журнал змін. Це означає, що ваша команда та користувачі API завжди знають, що і коли було змінено.
Вона включає такі функції, як власні домени, контроль доступу та інструменти командної співпраці. Ви можете зробити вашу документацію публічною або зберегти її приватною з паролем.
Як використовувати Bump
Використання Bump просте і вписується у ваш існуючий робочий процес:
Почніть зі створення безкоштовного акаунту на сайті Bump та налаштуйте свій перший хаб документації.
Завантажте свій файл специфікації OpenAPI або AsyncAPI через веб-інтерфейс або підключіть його до свого репозиторію GitHub для автоматичних оновлень.
Підключіть Bump до вашої системи безперервної інтеграції, щоб документація оновлювалася автоматично при внесенні змін у код.
Налаштуйте документацію, додавши логотип вашої компанії, обравши власний домен і підкоригувавши кольори відповідно до вашого бренду.
Встановіть контроль доступу, щоб визначити, хто може переглядати вашу документацію. Ви можете зробити її публічною або запросити конкретних членів команди та зовнішніх користувачів.
Використовуйте функцію API Explorer, щоб дозволити користувачам тестувати ваш API безпосередньо зі сторінки документації.
Увімкніть вебхуки, щоб отримувати сповіщення про зміни в API, тримаючи вашу команду в курсі через Slack або інші інструменти.
Функції Bump
Автоматична документація з файлів OpenAPI та AsyncAPI
Живий журнал змін API з виявленням критичних змін
Інтерактивний дослідник API для тестування кінцевих точок
Хаби документації для організації кількох API
Інтеграція з GitHub та GitLab
Користувацькі домени та опції брендування
Управління гілками для різних версій
Командна співпраця з контролем доступу
Сповіщення через вебхуки
Підсумковий лист електронною поштою про зміни API
Ціноутворення Bump
Basic
Free
- 10 сторінок документації
- 5 користувачів команди
- 30 гостьових користувачів
- Підтримка OpenAPI та AsyncAPI
- Підтримка накладок
- Безшовний досвід на одній сторінці
- Повна інтеграція CI
- Користувацький домен і логотип
- Центри документації
- Автоматичний журнал змін
Business
$700 /міс
- 100 сторінок документації
- Необмежена кількість користувачів команди
- Необмежена кількість гостьових користувачів
- Усі функції базового плану
- Управління гілками для кількох версій
- API-оглядач для тестування кінцевих точок
- Можливість відкотити випуск
- Користувацький CSS та JavaScript
- Єдиний вхід (SSO)
- Призначений менеджер з облікових записів
Enterprise
$2000 /міс
- Необмежена кількість сторінок документації
- Необмежена кількість користувачів і гостей
- Усі функції бізнес-плану
- Ручне керування випуском
- Режим зворотного проксі та вбудовування
- Індивідуальні звіти та аналітика
- Індивідуальні юридичні угоди та виставлення рахунків
- Пріоритетні запити на функції
- Гарантія рівня обслуговування (SLA) 99,99%
- Виділена команда підтримки
Випадки використання Bump
Хто може отримати користь від Bump
Часті запитання про Bump
Поділіться своїм досвідом з Bump
Подивіться, що користувачі кажуть про Bump
0 Огляди
Ще немає оглядів
Будьте першим, хто напише огляд Bump
Вбудувати значки Bump
Покажіть своїй спільноті, що Bump представлений на Tool Questor. Додайте ці красиві значки на свій веб-сайт, документацію або соціальні профілі, щоб підвищити довіру та залучити більше трафіку.
