Swagger UI / Editor like page - добавить на мой веб-сайт

Я создал файл YAML (и файл JSON соответственно) вручную с помощью редактора swagger.

Теперь я хочу встроить классную автоматически сгенерированную страницу из инструмента swagger-editor на свой веб-сайт, чтобы пользователи могли прочитать и протестировать ее (с помощью кнопки «Попробовать эту операцию») в моем API в реальном времени.

Я не хочу, чтобы чванство генерировало для меня какой-либо код, и мне не нужно автоматически обновлять документацию (YAML или что-то еще). Я буду обновлять свой статический файл YAML / JSON, когда мне понадобится - вручную. Поддерживает ли чванство такую ​​функцию? Это что-то связано с «Создать клиента» на панели инструментов редактора чванства? Я ищу файлы html / js / css, которые могут загружать статический файл YAML и генерировать что-то похожее на правую страницу редактора swagger. Кстати, я использую веб-сервер Apache (не так важно).

Спасибо!

РЕДАКТИРОВАТЬ: я ищу только на стороне клиента - некоторые js / css / html, которые могут добавить вышеуказанные требования, я не против периодически генерировать его снова (всякий раз, когда я изменяю мой файл YAML / мой REST API)


yaml swagger swagger-ui swagger-2.0 swagger-editor
person ItayB    schedule 09.12.2015    source источник

Ответы (2)


arrow_upward
6
arrow_downward

Что ж, я нашел инструмент, который искал, это swagger-ui. Он не выглядит точно так же, как пользовательский интерфейс правой стороны редактора swagger, но он удовлетворяет моим требованиям - он анализирует мой файл JSON (который я написал вручную как YAML) на стороне клиента в Интернете только со статическими файлами (без работы на стороне сервера, только обслуживание страниц) .

Спасибо, в любом случае!

РЕДАКТИРОВАТЬ: я обнаружил, что больше людей интересуются решением просмотра редактора по следующей ссылке < / а>

EDIT2: я добавил короткий грязный обходной путь для предварительного просмотра только соответствующего раздела редактора swagger. Вы можете увидеть изменения здесь. Можешь попробовать:

  1. клонировать мое разветвленное репо: git clone http://github.com/itayB/swagger-editor.git
  2. cd swagger-editor
  3. npm install
  4. npm start

Обратите внимание: этот предварительный просмотр показывает вывод файла spec-files / default.yaml. Я только внес некоторые изменения в представление, вся логика редактора все еще отстает.

Ваше здоровье

person ItayB    schedule 16.12.2015
comment
Спасибо, что подтвердили это. Я пытаюсь сделать то же самое и думал, что swagger-ui был тем инструментом, который я искал. - person andymal; 16.12.2015
comment
@andymal да, просто следуйте их инструкциям в github .. (необходим только первый шаг) - клонируйте проект, используйте каталог dist и скопируйте туда свой json файл. Вам может потребоваться отредактировать файл index.html, указав путь к файлу json, если вы поместите его в другое место .. - person ItayB; 16.12.2015
comment
Готовность к работе за 20 минут. Какой классный проект! Все, что мне нужно было сделать, это указать index.html на мой сгенерированный файл json, и он заработал. Хороший! - person andymal; 16.12.2015
comment
@andymal Поздравляю! - person ItayB; 16.12.2015

arrow_upward
1
arrow_downward

Я думаю, вы ищете swagger-server (https://github.com/BigstickCarpet/swagger-server < / а>).

person ZioByte    schedule 09.12.2015
comment
Спасибо, я проверю и обновлю, если это то, что я искал, но на первый взгляд - он требует node.js и не может обрабатывать синтаксический анализ YAML на стороне клиента .. - person ItayB; 09.12.2015