6

我已经通过swagger editor手动创建了 YAML 文件(和 JSON 文件) 。

现在我想将 swagger-editor 工具中酷炫的自动生成页面嵌入到我的网站中,以便用户可以实时阅读和测试它(通过“尝试此操作”按钮)我的 API。

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

谢谢!

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

4

2 回答 2

6

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

不管怎么说,还是要谢谢你!

编辑:我发现更多人对以下链接中的编辑器视图解决方案感兴趣

EDIT2:我添加了一个简短的解决方法,用于仅预览 swagger-editor 的相关部分。您可以在此处查看更改。你可以试试:

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

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

干杯

于 2015-12-16T09:32:26.707 回答
1

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

于 2015-12-09T20:37:35.937 回答