Проблема
Когда API нужно передать в виде обычного документа, разработчики вручную копируют описание эндпоинтов, параметры и примеры из Swagger.
Браузерное расширение
Swagger Converter Extension
Спецификация превращается в документ
Chrome-расширение превращает Swagger/OpenAPI-спецификацию в DOCX с описанием эндпоинтов, запросов и ответов.
Решение
Расширение принимает OpenAPI-спецификацию и автоматически формирует структурированный DOCX с основными данными API.
Один законченный сценарий
Как это работает
- 01
Пользователь передаёт расширению Swagger/OpenAPI-спецификацию.
- 02
Структура API разбирается на эндпоинты, запросы и ответы.
- 03
Данные преобразуются в читаемую структуру документа.
- 04
Готовый DOCX можно скачать и передать дальше.
Внутри проекта
Основные
возможности
Чтение Swagger/OpenAPIОписание эндпоинтовПараметры запросов и ответовФормирование DOCX
О проекте
Вопросы и ответы
Зачем DOCX, если существует Swagger UI?
DOCX нужен в процессах, где документацию согласуют, архивируют или передают людям вне среды разработки.
Где прочитать историю проекта?
Процесс и мотивы разработки описаны в отдельной статье на Хабре, ссылка доступна на странице проекта и в репозитории.
Нужно приложение для похожего процесса?
Опишите, какие действия приходится повторять. Выберем между веб-приложением, расширением и небольшой интеграцией.