一、环境依赖
本文基于 springboot 2.1.6,maven为构建工具,增强的 swagger (Swagger Bootstrap UI)版本为 1.9.3,在原有swagger 的项目里集成就可以,能够减少后端开发非常多的写接口文档的时间,高效且直观,使用详情请看官方文档以及 swagger 注解使用文档
二、安装配置操作步骤
1、在 maven 的中央仓库,找到增强 swagger(Swagger Bootstrap UI) 的依赖版本,有很多种,这里选择 1.9.3
https://mvnrepository.com/artifact/com.github.xiaoymin/swagger-bootstrap-ui
2、点击 1.9.3 进入详情
3、可以看到这里有很多构建工具,这里选择 maven
4、复制上图所示依赖,放到项目的 pom 文件中,并且 maven 更新下,将依赖打入仓库
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/swagger-bootstrap-ui -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.3</version>
</dependency>
5、在原有的 swagger 配置类上添加如下注解;
6、启动项目,浏览器访问 http://ip+port 或者域名 /doc.html,例如:http://localhost:8010/doc.html
7、启用 增强ui
8、查看单个接口的文档:
9、调试接口:
三、将文档导出为离线文档输出
1、文档管理->离线文档->拷贝文档
2、下载安装 Typora:
https://www.typora.io/
3、下载安装 pandoc (typora 导出需要 pandoc 支持):
https://github.com/jgm/pandoc/releases/tag/2.7.3
安装完 pandoc 以后需要重启电脑生效
4、打开 Typora,将第一步拷贝的文档粘贴进去面板:
5、左上角文件->导出->选择不同格式导出保存:
Pdf导出以后示例:
四、增强swagger 说明文档:
https://doc.xiaominfo.com/guide/