Swagger介绍 1.什么是Swagger 作为后端程序开发,我们多多少少写过几个后台接口项目,不管是编写手机端接口,还是目前比较火热的前后端分离项目,前端与后端都是由不同的工程师进行开发,那么这之间的沟通交流通过接口文档进行连接。但往往伴随很多问题,后端程序员认为编写接口文档及维护太花费时间精力,前端的认为接口文档变动更新不及时,导致程序之间相互调用出行问题。那么能简化接口文档的编写直接自动生成吗?当然能!如是乎Swagger这种接口文档在线自动生成工具便孕育而生。 Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。 2.Swagger优点 代码变,文档变。只需要少量的注解,Swagger 就可以根据代码自动生成 API 文档,很好的保证了文档的时效性。 跨语言性,支持 40 多种语言。 Swagger UI 呈现出来的是一份可交互式的 API 文档,我们可以直接在文档页面尝试 API 的调用,省去了准备复杂的调用参数的过程。 还可以将文档规范导入相关的工具(例如 Postman、SoapUI), 这些工具将会为我们自动地创建自动化测试。 SpringBoot中整合Swagger 1.基础环境构建 首先搭建一个基础的SpringBoot项目,导入以下Swagger启动器 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter<artifactId> <version>3.0.0</version> </dependency> 编写一个用于测试的controller @RestController public class HelloController { @PostMapping(value = "/hello") public String hello(){ return "hello"; } } 编写Swagger的配置类 @Configuration @EnableOpenApi public class SwaggerConfig { } 运行启动输入地址:http://localhost:8080/swagger-ui/index.html 73 可以看到Swagger接口文档页面,说明基本配置环境成功! image1528×507 37.8 KB 注意事项: Swagger3.0版本的地址是http://localhost:8088/swagger-ui/index.html,2.x版本中访问的地址的为http://localhost:8088/swagger-ui.html 2.配置Swagger 配置Swagger首先需要构建其Bean实例 Docket 对象,在刚刚创建的 SwaggerConfig 配置类中创建一个Docket @Bean public Docket docket(){ retur