Redocly
Redocly — це платформа для створення, управління та публікації красивої документації API та порталів для розробників на основі визначень OpenAPI.
Що таке Redocly
Redocly — це платформа для документації API, яка допомагає створювати професійні портали для розробників. Ви починаєте з файлу OpenAPI, що описує ваш API, а Redocly перетворює його на чисту, зрозумілу документацію з прикладами та інтерактивними функціями.
Платформа включає кілька продуктів, що працюють разом. Reunite — це місце, де команди пишуть і переглядають контент. Realm доставляє кінцеву документацію вашим користувачам. Redoc — це відкритий движок, який відображає документацію API. Reef допомагає організувати та знаходити всі ваші API в одному каталозі.
На відміну від базових генераторів документації, Redocly надає повноцінний портал для розробників. Ви можете додавати посібники, навчальні матеріали та власні сторінки поряд із довідником API. Усе версіонується і автоматично оновлюється при зміні визначення API.
Як використовувати Redocly
Почати роботу з Redocly просто. Ось кроки для створення вашої документації:
Зареєструйтеся на сайті Redocly та розпочніть безкоштовний пробний період.
Підключіть свій репозиторій коду з GitHub, GitLab або Azure DevOps для автоматичної синхронізації файлів OpenAPI.
Завантажте або зв’яжіть файл визначення OpenAPI. Redocly підтримує версії OpenAPI 2.0, 3.0 та 3.1.
Налаштуйте зовнішній вигляд, змінюючи кольори, шрифти та додаючи свій логотип, щоб відповідати вашому бренду.
Додайте додаткові сторінки з контентом, використовуючи Markdown для посібників, навчальних матеріалів і розділів початку роботи.
Використовуйте вбудований редактор для написання та перегляду змін перед публікацією для вашої аудиторії.
Налаштуйте автоматичні збірки, щоб документація оновлювалася щоразу, коли ви змінюєте визначення API у вашому репозиторії.
Налаштуйте власний домен для розміщення документації під вашою веб-адресою.
Функції Redocly
Автоматична документація API з файлів OpenAPI
Красивий трьохпанельний макет з навігацією та прикладами
Інтерактивна консоль API для тестування кінцевих точок
Індивідуальні параметри брендування та стилізації
Git-робочий процес з автоматичними оновленнями
Підтримка багатоверсійних API
Розширений пошук з можливостями ШІ
Підтримка Markdown для посібників та навчальних матеріалів
Інструменти командної співпраці та рецензування
Включено хостинг на власному домені
Ціноутворення Redocly
Open Source (Redoc)
Free
- Безкоштовний рендерер документації з відкритим вихідним кодом
- Трьохпанельний адаптивний макет
- Підтримка OpenAPI 2.0, 3.0 та 3.1
- Самостійне розгортання
- Базові параметри налаштування
- Інструменти командного рядка
Pro
$28
- Платформа для спільної роботи Reunite
- Хостинг з власним доменом
- 1 проєкт
- 100 сторінок
- Інтеграція з Git (GitHub, GitLab, Azure)
- Візуальний веб-редактор
- Автоматичні збірки
- 30-денний безкоштовний пробний період
Enterprise
$66
- Усе в плані Pro
- 500 сторінок
- Єдиний вхід (SSO)
- Гостьовий доступ через єдиний вхід (SSO)
- Керування доступом на основі ролей (RBAC)
- Віддалене синхронізування вмісту
- Пошук на основі штучного інтелекту
- Пошуковий движок Typesense
- Аналітика та інсайти
- Підтримка серверів MCP
Enterprise+
Custom
- Усе в плані Enterprise
- Індивідуальні варіанти розміщення даних
- Присвячена підтримка з продажу
- Підтримка форм закупівель
- Опитувальники з безпеки
- Оплата за рахунком та процес замовлення на закупівлю (PO)
- Юридичні огляди та контракти
- Опції хостингу для одного орендаря
- Преміум підтримка
- Професійні послуги доступні
Випадки використання Redocly
Хто може отримати користь від Redocly
Часті запитання про Redocly
Поділіться своїм досвідом з Redocly
Подивіться, що користувачі кажуть про Redocly
0 Огляди
Ще немає оглядів
Будьте першим, хто напише огляд Redocly
Вбудувати значки Redocly
Покажіть своїй спільноті, що Redocly представлений на Tool Questor. Додайте ці красиві значки на свій веб-сайт, документацію або соціальні профілі, щоб підвищити довіру та залучити більше трафіку.
