swagger - 如何将 swagger editor 左窗口发布为文档

Question

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

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

有没有办法将内容发布到 html，使页面看起来像正确的面板？

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

Answer 1

据我所知，无法直接从 swagger 编辑器发布它，但您可以使用 swagger-ui。你只需要

1. download Swagger 的用户界面
2. 将其托管在您的团队可以访问的网络服务器上
3. 将您的 swagger 文档代码保存到一个任意文件名的新文件中，并将其也托管在您的网络服务器上。
4. 告诉 swagger-ui 它应该加载哪个文档文件。

对于最后一步，在 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 文档文件。