2016-10-27 1 views
2

Я хочу опубликовать правую панель редактора swagger.Как опубликовать редактор левого окна swagger в качестве документации

В настоящее время команде необходимо предоставить доступ к файлу yaml, и каждый пользователь должен скопировать & вставьте текст в редактор swagger, чтобы просмотреть рендеринг правой панели.

Есть ли способ опубликовать контент в html, чтобы страница выглядела как правая панель?

Примера редактор чванства Windown с отформатированным взглядом справа: http://azimi.me/presentations/building-swagger-editor/images/swagger-ui.png

ответ

4

AFAIK нет никакого способа, чтобы опубликовать его прямо из редактора развязности, но вы можете использовать чванство-UI. Все, что вам нужно, это

  1. download чванство-Ui
  2. разместить его на веб-сервере, который доступен для вашей команды
  3. сохранить чванство код документации на новый файл любого файла и разместить его на вашем веб-сервер тоже.
  4. скажите swagger-ui, какой файл документации он должен загрузить.

Для последнего шага обратите внимание на следующий фрагмент кода в index.html чванства-Ui в:

$(function() { 
    var url = window.location.search.match(/url=([^&]+)/); 
    if (url && url.length > 1) { 
    url = decodeURIComponent(url[1]); 
    } else { 
    url = "http://petstore.swagger.io/v2/swagger.json"; 
    } 

Замените значение линии url = "http://petstore.swagger.io/v2/swagger.json";, чтобы указать на файл чванство документации вы закачанный.

+0

Ссылка на документы https://github.com/swagger-api/swagger-ui#swaggerui – hmartos

Смежные вопросы