大家好，我是杨叔。每天进步一点点，关注我的微信公众号【程序员杨叔】，获取更多测试开发技术知识！今天分享的内容是：swagger集成到springboot教程

一、背景

由于后端接口可能要面对多个开发人员或多个开发团队使用，写完后会整理一份API接口文档。为了减少与其他团队平时开发期间的频繁沟通成本，传统做法我们会创建一份API文档来记录所有接口细节，然而这样的做法有以下几个问题：

1.由于接口众多，并且细节复杂（需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等），高质量地创建这份文档本身就是件非常吃力的事，下游的抱怨声不绝于耳。

2.随着时间推移，不断修改接口实现的时候，都必须同步修改接口文档，而文档与代码又处于两个不同的媒介，除非有严格的管理机制，不然很容易导致不一致现象。

为了解决上面这样的问题，发现了swagger2，自动生成文档的工具，它可以轻松的整合到Spring Boot中，并与Spring MVC程序配合组织出强大RESTful API文档。

它既可以减少我们创建文档的工作量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体，可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API。

测试同学很多都了解或者使用过swagger，对于接口测试来说非常的方便易用。但仅仅会使用是不够的，今天我们就更近一步，看看如何自己实现swagger接口。

二、Springboot集成Swagger

2.1、pom.xml文件中增加swagger的依赖包：

<!--swagger依赖-->
<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>

踩坑备注：比如你的springboot版本是2.2.2的，那么swagger依赖的版本也要用高版本的：2.9.2，版本之间有对应关系，如果参照网上的很多教程说的swagger也用2.2.2版本，会用不起报错。

2.2、增加一个SwaggerConfig文件，用于配置那些方法会暴露给Swagger：

2.3、controller文件里面添加对应的注解参数：

参照对应swagger页面来理解各注解参数的含义，很好理解：

2.4、最后在Swagger页面上查看、调试接口的效果：http://localhost/swagger-ui.html


登录页面：http://localhost/loginNew

注册页面：http://localhost/registerNew

项目源码已上传至我的百度网盘，地址在我的微信公众号同篇文章文末处，需要的朋友可以关注我的微信公众号，查看文章获取~

=========================================================
以上，如果对你有帮助，

欢迎搜索关注我的微信公众号【程序员杨叔】，免费了解获取更多测试相关干货内容资料，一起交流学习~