在学会了如何使用Swagger之后，我们已经能够轻松地为Spring MVC或SpringBoot的Web项目自动构建出API文档了。但是，构建的文档必须通过在项目中整合、或使用单独部署的和返回的配置信息才能展现出您所构建的API文档。本文将在使用Swagger的基础上，再介绍一种生成静态API文档的方法，以便于构建更轻量部署和使用的API文档。
Swagger使用说明：
Swagger2Markup是Github上的一个开源项目。该项目主要用来将Swagger自动生成的文档转换成几种流行的格式以便于静态部署和使用，比如：AsciiDoc、Markdown、Confluence。
项目主页：
在使用Swagger2Markup之前，我们先需要准备一个使用了Swagger的Web项目，。
生成AsciiDoc
生成AsciiDoc的方式有两种：
第一步：编辑增加需要使用的相关依赖和仓库
第二步：编写一个单元测试用例来生成执行生成文档的代码
以上代码内容很简单，大致说明几个关键内容：
如果不想分割结果文件，也可以通过替换为，将转换结果输出到一个单一的文件中，这样可以最终生成html的也是单一的。
在执行了上面的测试用例之后，我们就能在当前项目的目录下获得如下内容：
image.png
可以看到，这种方式在运行之后就生成出了5个不同的静态文件。
除了通过上面编写Java代码来生成的方式之外，swagger2markup还提供了对应的Maven插件来使用。对于上面的生成方式，完全可以通过在中增加如下插件来完成静态内容的生成。
配置执行命令
通过上面的配置，执行该插件的asciidoctor:process-asciidoc命令之后，就能在目录下生成最终可用的静态部署HTML了。在完成生成之后，可以直接通过浏览器来看查看，你就能看到类似下图的静态部署结果：
image.png
我的博客即将搬运同步至腾讯云+社区，邀请大家一同入驻：
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请联系我们，一经查实，本站将立刻删除。
如需转载请保留出处：https://51itzy.com/kjqy/205162.html