Swagger离线文档生成

Posted 2023-03-20

参考技术A 离线接口文档自动生成器

适用范围：

将标准的swagger.json文件解析并转换成一定格式的接口文档，其中文档的章节排序可以在index.adoc中自定义排序。生成的接口文档有html和pdf格式两种，由于插件转换中文需要特殊配置，默认生成的含中文的文档存在一定字体错乱，所以建议使用html格式文档。Html格式文档可以使用word打开，并转换成其他格式。

操作步骤：

1.      [endif]将ConvertSwagger.rar解压出来

2.      [endif][可选步骤]修改\ConvertSwagger\src\docs\asciidoc文件夹下面的index.adoc与manual_content.adoc,manual_content.adoc。index.adoc中可以将manual_content.adoc添加进去：

并在manual_content.adoc中添加自定义描述内容：

（可选）

3.      [endif]在\ConvertSwagger\target\swagger中添加swagger.json文件

4.      [endif]编译此工程 在ConvertSwagger目录中 mvn package

5.      [endif]在\ConvertSwagger\target\asciidoc\html中拿到html格式的接口文档，自动生成的文档名称默认是index.html。