首页 文章

如何生成离线Swagger API文档?

提问于
浏览
13

我有一个Spring Boot MVC java Web应用程序 . 我已经能够集成Springfox for API文档 . 当服务器启动并运行时,我可以直观地看到所有API .

如何生成OFFLINE swagger API文档?注意:我不想使用asciidoc或markdown文档,但我想在html文件中使用相同的swagger API用户界面 . 我想这样链接是相对于本地目录而不是本地主机服务器链接 . 谢谢

5 回答

  • 7

    Springfox允许您根据Spring注释轻松创建Swagger测试器/ API文档 .

    Swagger本身有一些工具可以让你生成离线/静态文档:

    它们都需要Swagger YAML或JSON文件 . 如果你不使用Spring,你可以使用生成的文件用于Swagger UI( /v2/api-docs?group=<group name> ) .

  • 1

    Swagger拥有生成离线文档的工具 .

    该工具是“Swagger2Markup”,位于@ Github .

    “Swagger2Markup”的输出可以用作swagger-ui的替代品,可以作为静态内容 .

    Here is an Example

    祝好运! :)

  • 5

    您可以在https://editor.swagger.io的"Generate Client"菜单下尝试"HTML"或"Dynamic HTML" . 有关静态文档的任何问题/反馈,请在Swagger Codegen Github回购中报告 .

    editor.swagger.io利用https://generator.swagger.io生成代码,而generator.swagger.io(Swagger Generator)是Swagger Codegen项目的一部分 .

  • 1

    你可以看一下https://www.DynamicApis.com . 您可以创建API门户并上传您的swagger JSON文档 . 该站点获取Swagger文档,并为您的API生成更好的用户界面以及一些非常酷的工具 .

    Here是门户API的一个示例,其中包含有关其中一个API的文档 .

  • 2

    Pretty-swag是Swagger Specification V2的UI,能够生成其他格式的静态HTML . 它的灵感来自Swagger编辑 .

    结帐https://github.com/twskj/pretty-swag

相关问题