1. Swagger简介
-
前后端分离
前端 -> 前端控制层、视图层
后端 -> 后端控制层、服务层、数据访问层
前后端通过API进行交互
前后端相对独立且松耦合
-
产生的问题
前后端集成,前端或者后端无法做到“及时协商,尽早解决”,最终导致问题集中爆发
-
解决方案
首先定义schema [ 计划的提纲 ],并实时跟踪最新的API,降低集成风险
-
Swagger
号称世界上最流行的API框架
Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新
直接运行,在线测试API
支持多种语言 (如:Java,PHP等)
官网:https://swagger.io/
2. SpringBoot集成Swagger
- 要求:jdk 1.8 + 否则swagger2无法运行
-
新建一个SpringBoot项目
-
添加Maven依赖
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
-
编写HelloController,测试确保运行成功
-
要使用Swagger,我们需要编写一个配置类-SwaggerConfig来配置 Swagger
@Configuration //配置类 @EnableSwagger2// 开启Swagger2的自动配置 public class SwaggerConfig { }
访问测试 :http://localhost:8080/swagger-ui.html ,可以看到swagger的界面
3. 配置Swagger
-
Swagger实例Bean是
Docket
,所以通过配置Docket实例来配置Swaggger@Bean //配置docket以配置Swagger具体参数 public Docket docket() { return new Docket(DocumentationType.SWAGGER_2); }
点进 Docket 查看
点进 DocumentationType
有三个属性
-
可以通过apiInfo()属性配置文档信息
//配置文档信息 private ApiInfo apiInfo() { Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱"); return new ApiInfo( "Swagger学习", // 标题 "学习演示如何配置Swagger", // 描述 "v1.0", // 版本 "http://terms.service.url/组织链接", // 组织链接 contact, // 联系人信息 "Apach 2.0 许可", // 许可 "许可链接", // 许可连接 new ArrayList<>()// 扩展 ); }
Docket 实例关联上 apiInfo()
@Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()); }
重启项目,访问测试 http://localhost:8080/swagger-ui.html 看下效果
4. 配置扫描接口
-
构建
Docket
时通过select()
方法配置怎么扫描接口@Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口 .apis(RequestHandlerSelectors.basePackage("com.demo.swagger.controller")) .build(); }
重启项目测试,由于我们配置根据包的路径扫描接口,所以我们只能看到一个类
-
-
除了通过包路径配置扫描接口外,还可以通过配置其他方式扫描接口,这里注释一下所有的配置方式
RequestHandlerSelectors 配置要扫描的接口的方式
basePackage() 指定要扫描的包
any() 扫描所有
none() 都不扫描
withClassAnnotation(注解类的反射对象) 扫描类上的注解
withMethodAnnotation(注解类的反射对象) 扫描方法上的注解 -
除此之外,我们还可以配置接口扫描过滤:
@Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口 .apis(RequestHandlerSelectors.basePackage("com.demo.swagger.controller")) // 配置如何通过path过滤,即这里只扫描请求以/demo开头的接口 .paths(PathSelectors.ant("/demo/**")) .build(); }
这里的可选值还有
any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) //通过正则表达式控制
ant(final String antPattern) // 通过ant()控制5. 配置Swagger开关
-
通过
enable()
方法配置是否启用swagger,如果是false,swagger将不能在浏览器中访问了 -
如何动态配置当项目处于test、dev环境时显示swagger,处于prod时不显示?
@Bean public Docket docket(Environment environment) { // 设置要显示swagger的环境 Profiles of = Profiles.of("dev", "test"); // 判断当前是否处于该环境 // 通过 enable() 接收此参数判断是否要显示 boolean b = environment.acceptsProfiles(of); return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .enable(b) //配置是否启用Swagger,如果是false,在浏览器将无法访问 .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口 .apis(RequestHandlerSelectors.basePackage("com.demo.swagger.controller")) // 配置如何通过path过滤,即这里只扫描请求以/demo开头的接口 .paths(PathSelectors.ant("/demo/**")) .build(); }
可以在项目中增加一个dev的配置文件查看效果
6. 配置API分组
-
如果没有配置分组,默认是default。通过groupName()方法即可配置分组
-
重启项目查看分组
-
如何配置多个分组?
配置多个分组只需要配置多个docket即可
注意不能重名@Bean public Docket docket1(){ return new Docket(DocumentationType.SWAGGER_2).groupName("group1"); } @Bean public Docket docket2(){ return new Docket(DocumentationType.SWAGGER_2).groupName("group2"); } @Bean public Docket docket3(){ return new Docket(DocumentationType.SWAGGER_2).groupName("group3"); }
重启项目查看
7. 实体配置
-
新建一个实体类
@ApiModel("用户实体") public class User { @ApiModelProperty("用户名") public String username; @ApiModelProperty("密码") public String password; }
只要这个实体在请求接口的返回值上(即使是泛型),都能映射到实体项中
@RequestMapping("/getUser") public User getUser(){ return new User(); }
重启查看测试
-
注 :
并不是因为@ApiModel这个注解让实体显示在这里了,而是只要出现在接口方法的返回值上的实体都会显示在这里,而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。@ApiModel为类添加注释
@ApiModelProperty为类属性添加注释
8. 常用注解
Swagger的所有注解定义在io.swagger.annotations包下
下面列一些经常用到的,未列举出来的可以另行查阅说明
Swagger注解 简单说明 @Api(tags = “xxx模块说明”) 作用在模块类上 @ApiOperation(“xxx接口说明”) 作用在接口方法上 @ApiModel(“xxxPOJO说明”) 作用在模型类上:如VO、BO @ApiModelProperty(value = “xxx属性说明”,hidden = true) 作用在类方法和属性上,hidden设置为true可以隐藏该属性 @ApiParam(“xxx参数说明”) 作用在参数、方法和字段上,类似@ApiModelProperty 也可以给请求的接口配置一些注释
@ApiOperation("Hello控制类") @PostMapping("/hehe") @ResponseBody public String hello(@ApiParam("用户名")String username){ return username; }
这样的话,可以给一些比较难理解的属性或者接口,增加一些配置信息,让人更容易阅读!
相较于传统的Postman或Curl方式测试接口,使用swagger简直就是傻瓜式操作,不需要额外说明文档(写得好本身就是文档)而且更不容易出错,只需要录入数据然后点击Execute,如果再配合自动化框架,可以说基本就不需要人为操作了。
注意
在正式环境要记得关闭Swagger,一来出于安全考虑二来也可以节省运行时内存。-