openapi gui

Openapi-Gui

OpenApi-Gui-это графический интерфейс для создания и редактирования версии OpenAPI версии 3.0.x json/yaml. В своей текущей форме он наиболее полезен в качестве инструмента для начала и редактирования простых определений OpenAPI. Импортированные определения OpenAPI 2.0 автоматически преобразуются в V3.0.

Для предыдущей версии только Swagger / OpenAPI 2.0 см. Здесь. Эта версия в настоящее время не подходит, кроме исправлений безопасности.

Этот проект изначально был вилкой йодоктора Дэрила Куна, который, в свою очередь, был вдохновлен йодоктором Брэндоном Уэстом, который был написан на Руби. Полная история проекта поддерживается на GitHub.

Описание

Как это работает

Выберите существующее определение OpenAPI 2.0 или 3.0.x, чтобы загрузить или создать новое определение и начать добавлять пути, операции и параметры. Когда используется существующее определение, оно анализируется и формируется для редактирования каждого пути, будет создана операция и параметр.

Вы можете загрузить существующее определение, добавив параметр ?url= на начальную страницу начала, а значение - URL, которое вы хотите загрузить. При использовании Docker вы можете установить значение параметра запроса url на %2fserve , чтобы поднять определение, которое вы передали в командной линии Docker.

Нажмите на элемент из меню слева, чтобы начать редактирование. Посмотрите вывод JSON/YAML в любое время, выбрав одну из вкладки «Экспорт». По завершении загрузите вывод, чтобы сохранить его локально или скопируйте его буфер обмена. Openapi-Gui хранит только одно определение за раз, и это в местном хранении вашего браузера. Убедитесь, что вы сохраняете свой вывод JSON/YAML локально.

Прежде чем выполнять разрушительное действие, Openapi-Gui сохраняет текущее состояние определения. В любое время вы должны помнить, чтобы выбрать сохранение вручную.

Технология

Openapi-Gui работает полностью на стороне клиента, используя ряд фреймворков JavaScript, включая Vue.js, JQuery и Bulma для CSS.

Чтобы поднять приложение и запустить, просто посмотрите на живую версию на страницах GitHub, разверните клон на страницы GitHub, разверните в Heroku, используя кнопку ниже, или клонировать репо и указать браузер на index.html или размещать ее сами - не может быть проще. Больше технической информации здесь.

Вам нужно только npm install модули Node.js, если вы хотите использовать встроенный веб-сервер openapi-gui (то есть, если вы используете свой собственный веб-сервер), в противном случае они находятся только для развертывания PAAS.

CLI варианты

 -d, --definition    serve the given OAS definition
-l, --launch        start a web-browser pointing to the GUI
-p, --port          specify the port to run on, defaults to $PORT or 3000
-w, --write         enable writing back to the source definition

Бег с докером

Если у вас нет местной среды разработки узлов, или если вы предпочитаете запустить Openapi-Gui в контейнере Docker, вы можете сделать с несколькими простыми шагами:

1. Клонировать репозиторий.
2. Запустите docker build -t mermade/openapi-gui . Чтобы построить изображение Docker ( mermade/openapi-gui )
3. Запустите docker run --name openapi-gui -p 8080:3000 -d mermade/openapi-gui чтобы запустить сервер на порту 8080.
4. Перейдите к http://localhost:8080 в вашем любимом браузере.
5. Когда вы закончите, выключите сервер, запустив docker stop openapi-gui && docker rm openapi-gui

Или вы можете потянуть предварительно построенное изображение Docker:

• docker pull mermade/openapi-gui

Ограничения

• Openapi-Gui будет отменять общие параметры.
• Определение должно быть автономным без внешнего $ref . Это, вероятно, будет решено (Ho-ho) в ближайшее время .
• Редактирование ответа / пример / схема тела будет рассмотреть его.
• OpenApi-Gui не всегда будет сохранять поставщиков-эксплуации, например, если параметр удален и воссоздан.
• OpenApi-Gui не будет сохранять комментарии из определений, импортированных в формате YAML.

Тодо

• См. Список TODO и текущее состояние поддержки спецификации OpenAPI 3.0.