Что это такое?
Redoc — это open-source инструмент, который генерирует справочную документацию по API из определений OpenAPI (ранее Swagger). Он превращает ваш spec-файл в аккуратную и удобную для чтения справочную страницу.
Redoc — это open-source инструмент, который генерирует справочную документацию по API из определений OpenAPI (ранее Swagger). Он превращает ваш spec-файл в аккуратную и удобную для чтения справочную страницу.Как выглядит сгенерированная документация?Это веб-страница из трёх панелей, которая адаптируется под размер экрана: слева строка поиска и меню навигации, в центре сама документация, а справа примеры запросов и ответов.
Это веб-страница из трёх панелей, которая адаптируется под размер экрана: слева строка поиска и меню навигации, в центре сама документация, а справа примеры запросов и ответов.Как сгенерировать документацию из моего spec-файла?Когда Node установлен, запустите Redocly CLI через npx, указав своё определение OpenAPI — на выходе получится файл redoc-static.html, который можно сразу открыть в браузере.
Когда Node установлен, запустите Redocly CLI через npx, указав своё определение OpenAPI — на выходе получится файл redoc-static.html, который можно сразу открыть в браузере.Для этого нужен Node?Для варианта с CLI нужен Node. Если не хочется его настраивать, есть Docker-образ, HTML-тег, который можно вставить в любую страницу, и React-компонент для интеграции в приложение.
Для варианта с CLI нужен Node. Если не хочется его настраивать, есть Docker-образ, HTML-тег, который можно вставить в любую страницу, и React-компонент для интеграции в приложение.Чего я лишаюсь, используя это вместо облачного продукта Redocly?Redoc — это версия для сообщества. Платная облачная версия дополнительно даёт консоль для тестирования запросов, автоматическую генерацию примеров кода, полностью настраиваемые стили, mock-сервер, а также поддержку AsyncAPI и GraphQL.
Redoc — это версия для сообщества. Платная облачная версия дополнительно даёт консоль для тестирования запросов, автоматическую генерацию примеров кода, полностью настраиваемые стили, mock-сервер, а также поддержку AsyncAPI и GraphQL.Какие форматы описания API он принимает?Поддерживаются OpenAPI 3.1, OpenAPI 3.0 и устаревший Swagger 2.0, так что старые Swagger-спецификации работают без конвертации.
Поддерживаются OpenAPI 3.1, OpenAPI 3.0 и устаревший Swagger 2.0, так что старые Swagger-спецификации работают без конвертации.Можно посмотреть документацию, ничего не устанавливая?Да — есть онлайн-демо, которое по умолчанию показывает пример API Petstore; введите URL своего определения OpenAPI и нажмите TRY IT, чтобы увидеть, как Redoc его отрисует.
Да — есть онлайн-демо, которое по умолчанию показывает пример API Petstore; введите URL своего определения OpenAPI и нажмите TRY IT, чтобы увидеть, как Redoc его отрисует.CLI годится только для генерации HTML-файла?Нет — Redocly CLI также умеет делать линтинг и объединение (бандлинг) ваших OpenAPI-файлов, так что генерацию документации можно встроить в более широкий процесс работы с API.
Нет — Redocly CLI также умеет делать линтинг и объединение (бандлинг) ваших OpenAPI-файлов, так что генерацию документации можно встроить в более широкий процесс работы с API.Кто реально пользуется Redoc?В витрине проектов среди пользователей инструментов Redocly перечислены такие организации, как Docker Engine, Zuora, Discourse, Rebilly, APIs.guru и Quaderno API.
В витрине проектов среди пользователей инструментов Redocly перечислены такие организации, как Docker Engine, Zuora, Discourse, Rebilly, APIs.guru и Quaderno API.What are similar projects?swagger-ui, swag, forge, swagger-codegen, vibex, fastapi, openapi-generator, scalar
swagger-ui, swag, forge, swagger-codegen, vibex, fastapi, openapi-generator, scalarWhich topics is it in?openapi-specification, openapi3, documentation-generator, api-documentation, swagger, documentation-tool, openapi, reactjs, documentation, rest-api, hacktoberfest, npm
openapi-specification, openapi3, documentation-generator, api-documentation, swagger, documentation-tool, openapi, reactjs, documentation, rest-api, hacktoberfest, npm