java 如何生成离线Swagger API文档?

xqnpmsa8  于 2023-05-27  发布在  Java
关注(0)|答案(7)|浏览(219)

我有一个Sping Boot MVC Java Web应用程序。我已经能够为API文档集成Springfox。当服务器启动并运行时,我可以直观地看到所有的API。
如何生成OFFLINE swagger API文档?注意:我不想使用asciidoc或markdown文档,但我想在html文件中使用相同的swagger API用户界面。我想这样的链接是相对于本地目录,而不是本地主机服务器的链接。谢谢

oxcyiej7

oxcyiej71#

Swagger有生成离线文档的工具。
工具是“Swagger2Markup”,位于@ Github。
“Swagger 2 Markup”的输出可以用作swagger-ui的替代方案,并且可以用作静态内容。
Here is an Example
祝你好运!:)

holgip5t

holgip5t2#

Springfox允许您基于Spring注解轻松创建Swagger测试程序/API文档。
Swagger本身有一些工具允许您生成离线/静态文档:

  • Swagger Editor有几种生成文档的方法,列在Generate Client菜单中
  • SwaggerCodegen模块允许您生成静态和动态HTML文档

这两个都需要Swagger YAML或JSON文件。如果您使用的是Springfox,因此没有YAML/JSON中的Swagger定义,您可以使用为Swagger UI(/v2/api-docs?group=<group name>)生成的文件。

m2xkgtsf

m2xkgtsf3#

您可以在https://editor.swagger.io中的“生成客户端”菜单下尝试“HTML”或“动态HTML”。有关静态文档的任何问题/反馈,请在Swagger Codegen Github repo中报告。
editor.swagger.io 利用https://generator.swagger.io生成代码,generator.swagger.io(Swagger Generator)是Swagger Codegen项目的一部分。

ep6jt1vc

ep6jt1vc4#

打开live swagger HTML。单击展开所有操作。然后将HTML保存为PDF。
这应该会给予你一个体面的PDF API文档,其中包含所有细节。

vwkv1x7d

vwkv1x7d5#

Pretty-swag是Swagger规范V2的一个UI,能够生成静态HTML和其他格式。它的灵感来自于Swagger Editor。
结帐https://github.com/twskj/pretty-swag

ars1skjm

ars1skjm6#

你可以看看https://www.DynamicApis.com。您可以创建一个API门户并上传swagger JSON文档。这个站点使用Swagger文档并为您的API生成了一个更好的用户界面沿着一些非常酷的工具。
Here是门户API的一个示例,它在其中一个API上有文档。

ejk8hzay

ejk8hzay7#

此任务有两种方法

  1. Swagger本身有一些工具允许您生成离线/静态文档:
    GitHub上的swagger-api/swagger-codegen项目;项目README展示了如何使用它来生成静态HTML。请参阅生成静态html API文档。
    1.还有另一种轻松的方式来生成和共享离线Swagger API文档,并提供用户友好的界面。
    使用Syncloop,您可以上传Swagger API规范文件(通常为JSON或YAML格式)并生成视觉上吸引人的API文档。它允许您自定义API文档的样式和设置。一旦你满意了,你就可以下载生成的HTML文件。
    Here is an example

相关问题