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 або відправте в інший інструмент для подальшої роботи.