SpringBoot2.x系列教程(四十三)SpringBoot整合Swagger2
- 2020 年 3 月 18 日
- 笔记
在上篇文章中我们讲解了RESTful的概念及相关风格API的设计,那么针对多客户端的API,作为后端开发如何对接口进行验证呢?当然,可以通过写单元测试来完成。但如果还需要维护每个接口的API文档,同时还要保持版本更新维护呢?是不是工作量变得异常繁重了。
那么,Swagger的出现,可以帮助后端开发人员轻松的解决上述痛点。
针对接口的功能测试,你不仅可以通过单元测试来进行验证,还可以通过Swagger提供的可视化页面操作来进行操作完成。
针对API文档,通过Swagger提供的功能,可以系统的管理整个项目的API文档。
而Swagger又可以轻松整合到Spring Boot等项目中,与Spring MVC程序配合组织出强大RESTful API文档。
减少创建文档的繁琐操作,接口描述又整合入代码中,让维护文档和修改代码整合为一体。实现了在修改代码逻辑的同时轻松修改接口文档说明。
不仅如此,针对每个接口在页面上还提供了强大的测试功能,可以针对每一个接口进行测试操作。
效果及示例页面如下:

Spring Boot集成Swagger2
在Spring Boot中集成Swagger2是非常方便,特别是使用最新版本的Swagger2,只用添加依赖,配置实例化类,即可完成最简单的接口及API文档的呈现和使用。
引入依赖
这里引入当前最新版本的Swagger2的依赖:
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger