Repolode
Предложить
Redocly

Redocly/redoc

Инструмент с открытым исходным кодом для создания адаптивного трёхпанельного сайта со справочной документацией API на основе спецификаций OpenAPI, Swagger, AsyncAPI или GraphQL.

Open source альтернатива:SwaggerUI

Открыть на GitHubСайт
Звёзды
25,970
Форки
2,404
Открытые issues
366
Последний коммит
14 часов назад

Что это?

Redoc преобразует файл с описанием API в удобную для навигации страницу документации. Он поддерживает OpenAPI 3.2, 3.1 и 3.0, Swagger 2.0, а также AsyncAPI 3.x и GraphQL SDL и автоматически определяет формат. По умолчанию документация отображается в трёх панелях: слева — строка поиска и меню навигации, в центре — документация, справа — примеры запросов и ответов.

Redoc можно использовать разными способами: создать статический HTML-файл с помощью Redocly CLI через npx, встроить в HTML-страницу пользовательский элемент, загружающий URL спецификации, или отобразить документацию как компонент React. Оформление настраивается с помощью CSS-переменных, поддерживается тёмная тема, а расширения OpenAPI, такие как x-logo, x-tagGroups и x-codeSamples, позволяют изменить внешний вид документации.

Проект поддерживает Redocly. В коммерческой версии сервиса добавлены такие возможности, как панель try-it, mock-сервер и линтинг.

Ключевые возможности

  • 01Отображает спецификации OpenAPI 3.2, 3.1 и 3.0, а также Swagger 2.0
  • 02Поддерживает AsyncAPI 3.x и GraphQL SDL с автоматическим определением формата
  • 03Адаптивная трёхпанельная компоновка с синхронизированной навигацией
  • 04Тёмная тема и настройка оформления с помощью CSS-переменных
  • 05Доступен в виде HTML-тега, компонента React, команды Redocly CLI и Docker-образа

Сценарии использования

  • Публикация общедоступной справочной документации API на основе файла OpenAPI
  • Встраивание документации API в существующий сайт на React или статический HTML-сайт
  • Создание автономного HTML-файла для просмотра офлайн или внутреннего распространения

Быстрый старт

  1. 1

    Создайте документацию из файла OpenAPI с помощью npx (требуется Node).

    npx @redocly/cli build-docs openapi.yaml
  2. 2

    Откройте созданный файл redoc-static.html в браузере.

Что важно знать

  • В Community Edition отсутствуют такие функции, как панель Try-it, мок-сервер и поддержка SOAP. Они доступны только в размещённом продукте Redoc.
  • По умолчанию Redoc собирает анонимные данные об использовании и производительности. Чтобы отказаться от сбора, задайте disable-telemetry или disableTelemetry.

Темы

#api-documentation#openapi#swagger#documentation-generator#asyncapi#graphql#react#documentation-tool#hacktoberfest#openapi-specification

Частые вопросы

Что такое redoc?
Инструмент с открытым исходным кодом для создания адаптивного трёхпанельного сайта со справочной документацией API на основе спецификаций OpenAPI, Swagger, AsyncAPI или GraphQL. Redoc преобразует файл с описанием API в удобную для навигации страницу документации. Он поддерживает OpenAPI 3.2, 3.1 и 3.0, Swagger 2.0, а также AsyncAPI 3.x и GraphQL SDL и автоматически определяет формат. По умолчанию документация отображается в трёх панелях: слева — строка поиска и меню навигации, в центре — документация, справа — примеры запросов и ответов.
redoc можно использовать бесплатно? Какая у него лицензия?
redoc распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
redoc всё ещё поддерживается?
Активно поддерживается. Последний коммит в redoc — 20 окт. 2026 г..
Для чего можно использовать redoc?
Публикация общедоступной справочной документации API на основе файла OpenAPI Встраивание документации API в существующий сайт на React или статический HTML-сайт Создание автономного HTML-файла для просмотра офлайн или внутреннего распространения
Как установить redoc?
Создайте документацию из файла OpenAPI с помощью npx (требуется Node).: npx @redocly/cli build-docs openapi.yaml Откройте созданный файл redoc-static.html в браузере.
Где скачать redoc?
Исходный код и инструкции по установке — на GitHub: https://github.com/Redocly/redoc

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты