Swagger UI / Editor like page - 添加到我的网站

Swagger UI / Editor like page - add to my web site

我已经通过 swagger editor.

手动创建了 YAML 文件(和 JSON 文件)

现在我想将 swagger-editor 工具自动生成的超酷页面嵌入到我的网站中,这样用户就可以在我的 API 实时阅读和测试它(通过 'Try this operation' 按钮)。

我不希望 swagger 为我生成任何代码,我也不需要它自动更新文档(YAML 或其他)。我会在需要时手动更新我的静态 YAML/JSON 文件。 swagger 是否支持这种功能?它与 swagger 编辑器工具栏中的 'Generate Client' 相关吗? 我正在寻找一些 html/js/css 文件,它们可以加载静态 YAML 文件并生成类似于 swagger-editor 右侧页面的内容。 顺便说一句,我正在使用 Apache Web 服务器(不是那么重要)。

谢谢!

编辑: 我只在寻找客户端 - 一些 js/css/html 可以添加上述要求,我不介意不时再次生成它到时间(每当我更改我的 YAML 文件/我的 REST API)

我认为您正在寻找 swagger-server (https://github.com/BigstickCarpet/swagger-server)。

嗯, 我找到了我要找的工具,它是 swagger-ui。 它看起来并不完全像 swagger-editor 右侧 UI 但它满足我的要求 - 它在客户端在线解析我的 JSON 文件(我手动编写为 YAML),只有静态文件(没有服务器副业,只服务页面)。

谢谢!

编辑:我发现更多人对下面的编辑器视图解决方案感兴趣link

编辑2: 我添加了一个简短的变通方法,用于仅预览 swagger 编辑器的相关部分。您可以看到变化 here。 你可以试试看:

  1. 克隆 my forked 回购:git clone http://github.com/itayB/swagger-editor.git
  2. cd swagger-editor
  3. npm install
  4. npm start

请注意:此预览显示文件 spec-files/default.yaml 的输出。 我只做了一些视图更改,所有编辑器逻辑仍然 运行 落后。

干杯