之前的文章讲解了swagger2注解的用法以及实例演示,本篇文章介绍一下如何使用swagger2导出离线版的api文档,分为两种格式一个是HTML5一个是PDF。对象属性、接口说明、测试用例都可以导出来方便开发人员很清楚的了解接口!
相关版本
Springboot版本:1.5.10.RELEASE
swagger2版本:2.6.1
maven版本:3.2.5
JDK版本:8
IDEA版本:2017.2.6
大家自己测试的时候如果不成功尽量和我版本保持一致。
index.adoc配置
include::{generated}/overview.adoc[]
include::{generated}/definitions.adoc[]
include::{generated}/paths.adoc[]
pom.xml配置
pom里面不比之前需要多配置一些东西,这个是大家需要注意的。
properties配置:
UTF-8
UTF-8
1.8
${project.build.directory}/generated-snippets
${project.basedir}/docs/asciidoc
${project.build.directory}/asciidoc
${project.build.directory}/asciidoc/html
${project.build.directory}/asciidoc/pdf
dependencies依赖配置:
com.alibaba
fastjson
1.2.46
org.springframework.boot
spring-boot-starter
org.springframework.boot
spring-boot-starter-test
test
org.springframework.boot
spring-boot-starter-web
io.springfox
springfox-swagger2
2.6.1
io.springfox
springfox-swagger-ui
2.6.1
org.springframework.restdocs
spring-restdocs-mockmvc
1.1.2.RELEASE
test
io.springfox
springfox-staticdoc