首页
学习
活动
专区
圈层
工具
发布
25 篇文章
1
SpringBoot2.x系列教程(五十九)SpringBoot实现国际化i18n功能
2
SpringBoot2.x系列教程(五十五)Mybatis反向生成Java代码
3
SpringBoot2.x系列教程(四十四)WebSocket基础知识简介
4
SpringBoot2.x系列教程(四十三)SpringBoot整合Swagger2
5
SpringBoot2.x系列教程(五十)Spring Boot Idea中热部署(自动刷新)
6
SpringBoot2.x系列教程(四十二)SpringBoot中构建RESTful服务
7
SpringBoot2.x系列教程(三十八)SpringBoot配置Https访问
8
SpringBoot2.x系列教程(三十六)SpringBoot之Tomcat配置
9
SpringBoot2.x系列教程(三十四)Thymeleaf自动配置源码解析
10
SpringBoot2.x系列教程(三十三)Thymeleaf手动渲染实例讲解
11
SpringBoot2.x系列教程(三十二)Thymeleaf资源导入及公共布局
12
SpringBoot2.x系列教程(三十一)Thymeleaf的基本使用
13
SpringBoot2.x系列教程(三十)SpringBoot集成Thymeleaf
14
SpringBoot2.x系列教程(二十九)freemarker自动配置源码解析
15
SpringBoot2.x系列教程(二十八)freemarker基本语法使用
16
SpringBoot2.x系列教程(二十六)Springboot集成freemarker
17
SpringBoot2.x系列教程(二十五)Jsp中使用jstl和引入静态资源
18
SpringBoot2.x系列教程(二十三)SpringBoot集成Jsp
19
SpringBoot2.x系列教程(二十二)简单参数校验及统一异常处理
20
SpringBoot2.x系列教程(二十)自定义参数校验注解
21
SpringBoot2.x系列教程(十三)Jackson命名策略及自定义序列化
22
SpringBoot2.x系列教程(十)Json之基础使用详解
23
SpringBoot2.x系列教程(十九)Validation数据校验基础使用
24
SpringBoot2.x系列教程(九)基于Postman的RESTful接口调用
25
SpringBoot2.x系列教程(八)SpringBoot常用注解汇总

SpringBoot2.x系列教程(四十三)SpringBoot整合Swagger2

在上篇文章中我们讲解了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的依赖:

代码语言:javascript
复制
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger
下一篇
举报
领券