如何从swagger文档生成静态html文件？

Question

我创建了一个带有yaml文件的swagger文档:

 api/swagger/swagger.yaml

现在我想与它的定义共享一个静态的html文档,但是在swagger项目中已经说过,他们根本不打算支持html生成.

如何从swagger项目生成静态html文件？

Answer 1

1. 下载https://github.com/swagger-api/swagger-ui - 感兴趣的文件夹是“ dist ”
2. 将 Swagger JSON 复制到 dist 文件夹中
3. 打开 index.html 并将文件底部标签内的 URL 值更改为./swagger.json（或任何你的 swagger json 调用）（请参阅此处）
4. 主机上线！（或启动本地服务器以查看输出）。

Answer 2

我能想到的最简单的方法是使用Swagger编辑器:

1. 请访问:https://editor.swagger.io
2. 单击顶部菜单栏中的"文件",然后选择"导入文件"
3. 导入后,单击顶部菜单栏中的"生成客户端",然后选择"HTML"或"HTML2"以生成静态HTML文档

editor.swagger.io使用generator.swagger.io生成API客户端,服务器存根和文档,而generator.swagger.io则由开源项目Swagger Codegen提供支持.

Answer 3

有swagger2markup-cli可以生成静态adoc文件。

确保您已安装 Java 运行时。（我在用Java(TM) SE Runtime Environment (build 1.8.0_111-b14)）。

你获取罐子：

wget https://jcenter.bintray.com/io/github/swagger2markup/swagger2markup-cli/1.1.0/swagger2markup-cli-1.1.0.jar

adoc您可以通过以下方式生成静态：

java -jar ~/your/path/swagger2markup-cli-1.1.0.jar convert  -i api/swagger/swagger.yaml --outputFile static-swagger

html然后可以通过以下方式将该 adoc 文件转换为文件asciidoctor：

asciidoctor *.adoc

你可能需要安装它，因为我使用的是 Ubuntu，我可以通过以下方式安装：

sudo apt-get -qq install asciidoctor