平时使用Swagger进行接口测试很方便,但是前端需要接口文档咋办呢,又不让直接扔一个在线的Swagger接口测试过去。
于是,本着能不动手写就绝不动手的原则,我找到了swagger-bootstrap-ui这个工具,它可以帮助我们生成word、pdf…这些文档。
1.首先,导入Swagger和swagger-bootstrap-ui的依赖
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
这里需要注意的是,Swagger和swagger-bootstrap-ui可能会发生版本冲突的问题,别问我是怎么知道的。
开始我使用的是Swagger 3.0.0的版本,然后就出问题了。
2.在原有的 swagger 配置类上添加@EnableSwaggerBootstrapUI注解(这里我导出文档结束了,所以注释掉了):
3.启动项目,浏览器访问 http://ip+port 或者域名 /doc.html(这里不方便截公司项目的图,就网上找了)
4.生成文档。拷贝文档之后,将拷贝的内容粘贴到typora中,然后通过typora导出pdf、word等文档。