使用Swagger2Markup 实现导出的API漂亮的HTML和PDF文档

感情迁移 提交于 2020-03-17 09:15:13

使用swagger完整的生成PDF和HTML的漂亮文档终于完工啦,分享如下:

一、先看下生成效果

二、操作步骤

1、修改生成最终文档的索引文件index.adoc,在src/docs/asciidoc目录中,根据自己需要添加章节
include::{generated}/overview.adoc[]
include::manual_content1.adoc[]
include::manual_content2.adoc[]
include::{generated}/paths.adoc[]
include::{generated}/security.adoc[]
include::{generated}/definitions.adoc[]
   
2、修改pom.xml的30行地址,改为需要生成文档的系统地址
3、使用命令:mvn clean test 生成接口手册文档

4、生成的的文档路径:
生成HTML文档: target\asciidoc\html
生成PDF文档  : target\asciidoc\pdf

三、完整工程下载地址如下:

https://download.csdn.net/download/iamghost007/12247642

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!