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
- Настраиваемые варианты размещения данных
- Персональная помощь отдела продаж
- Поддержка форм закупок
- Анкеты по безопасности
- Оплата по счету и процесс заказа по накладной
- Юридические обзоры и контракты
- Варианты хостинга с выделенным размещением
- Премиум поддержка
- Доступны профессиональные услуги
Сценарии использования Redocly
Кто может воспользоваться Redocly?
Часто задаваемые вопросы о Redocly
Поделитесь своим опытом с Redocly
Посмотрите, что пользователи говорят о Redocly
0 Отзывы
Пока нет отзывов
Станьте первым, кто оценит Redocly
Встроить значки Redocly
Покажите своему сообществу, что Redocly представлен на Tool Questor. Добавьте эти красивые значки на свой веб-сайт, в документацию или социальные профили, чтобы повысить доверие и привлечь больше трафика.
