如何发布swagger编辑器左窗口作为文档

时间:2016-10-27 13:58:01

标签: swagger swagger-editor

我想发布swagger编辑器的右侧面板。

目前,团队必须共享yaml文件,每个用户都必须复制&将文本粘贴到swagger编辑器中以查看正确的面板渲染。

有没有办法将内容发布到html,以便页面看起来像右边的面板?

示例swagger编辑器窗口右侧有格式化外观: http://azimi.me/presentations/building-swagger-editor/images/swagger-ui.png

1 个答案:

答案 0 :(得分:5)

AFAIK没有办法直接从swagger编辑器发布它,但你可以使用swagger-ui。

你需要的只是

  1. download swagger-ui
  2. 将其托管在您的团队可访问的网络服务器上
  3. 将您的招摇文档代码保存到任何文件名的新文件中,并将其托管在您的Web服务器上。
  4. 告诉swagger-ui它应加载哪个文档文件。
  5. 在最后一步中,在swagger-ui的index.html中查找以下代码:

    $(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";的值替换为指向您上传的swagger文档文件。