Redocly

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

Платформа включает несколько продуктов, работающих вместе. Reunite — место, где команды пишут и проверяют контент. Realm предоставляет конечную документацию вашим пользователям. Redoc — это движок с открытым исходным кодом, который отображает справочные документы по API. Reef помогает организовать и найти все ваши API в одном каталоге.

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

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

• Красивый трехпанельный макет с навигацией и примерами

• Интерактивная консоль API для тестирования эндпоинтов

• Настройка брендинга и стилей

• Рабочий процесс с Git с автоматическими обновлениями

• Поддержка нескольких версий API

• Продвинутый поиск с возможностями ИИ

• Поддержка Markdown для руководств и учебных материалов

• Инструменты для командного сотрудничества и рецензирования

• Включен хостинг на собственном домене