OpenAPI в Markdown документацию
Преобразуйте документ OpenAPI или Swagger в читаемую документацию API в Markdown.
OpenAPI в Markdown документацию
Вставьте документ OpenAPI 3 или Swagger 2 в формате JSON или YAML — инструмент преобразует его в Markdown документ для API, который можно добавить прямо в README, вики-страницу или сайт с документацией. Каждая операция становится отдельным разделом, поэтому спецификация, которую можно читать только компьютеру, превращается в документ, который коллега или новый разработчик могут быстро просмотреть.
Вывод содержит оглавление со ссылками на все группы и операции, таблицу параметров (или простой список) для параметров пути, запроса, заголовка и cookie, сгенерированный пример тела запроса, таблицу кодов ответов с описаниями и пример тела ответа из первой подходящей схемы. Вы можете группировать операции по тегам или первому сегменту пути, выбирать, как отображаются примеры запросов (JSON тело или готовая к использованию curl команда), и управлять глубиной заголовков операций для вложения результата в существующий документ. Один переключатель включает или исключает устаревшие операции, другой добавляет все схемы из компонентов (или Swagger определений) как отдельные разделы в конце.
Показатели "$ref" в одном файле автоматически разворачиваются для параметров, тел запросов и ответов, а также схем, поэтому спецификация, использующая компоненты, создает полные таблицы и примеры вместо простых строк $ref. Ссылки на другие файлы или URL остаются без изменений, так как этот инструмент никогда не делает сетевых запросов. Если Markdown превышает лимит вывода, вы получите четкое сообщение вместо зависания вкладки.
Все работает локально в вашем браузере — ваша спецификация API, которая часто описывает системы, которые вы не хотите раскрывать, никогда не загружается куда-либо. Скопируйте Markdown, загрузите его как файл .txt или отправьте в другой инструмент для дальнейшей работы.