SpringBoot14:集成Swagger终极版

郎家岭伯爵 2021年12月08日 587次浏览

项目集成Swagger

学习目标:

  • 了解Swagger的概念及作用

  • 掌握在项目中集成Swagger自动生成API文档

Swagger简介

前后端分离

  • 前端 -> 前端控制层、视图层

  • 后端 -> 后端控制层、服务层、数据访问层

  • 前后端通过API进行交互

  • 前后端相对独立且松耦合

产生的问题

  • 前后端集成,前端或者后端无法做到“及时协商,尽早解决”,最终导致问题集中爆发

解决方案

  • 首先定义schema [ 计划的提纲 ],并实时跟踪最新的API,降低集成风险

Swagger

  • 号称世界上最流行的API框架

  • Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新

  • 直接运行,在线测试API

  • 支持多种语言 (如:Java,PHP等)

  • 官网:https://swagger.io/

SpringBoot集成Swagger

SpringBoot集成Swagger => springfox,两个jar包

  • Springfox-swagger2

  • swagger-springmvc

使用Swagger

要求:jdk 1.8 + 否则swagger2无法运行

步骤:

  1. 新建一个SpringBoot-web项目

  2. 添加Maven依赖

  1. <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
  2. <dependency>
  3. <groupId>io.springfox</groupId>
  4. <artifactId>springfox-swagger2</artifactId>
  5. <version>2.9.2</version>
  6. </dependency>
  7. <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
  8. <dependency>
  9. <groupId>io.springfox</groupId>
  10. <artifactId>springfox-swagger-ui</artifactId>
  11. <version>2.9.2</version>
  12. </dependency>
  1. 编写HelloController,测试确保运行成功!

  2. 要使用Swagger,我们需要编写一个配置类-SwaggerConfig来配置 Swagger

  1. @Configuration //配置类
  2. @EnableSwagger2// 开启Swagger2的自动配置
  3. public class SwaggerConfig {
  4. }
  1. 访问测试 :http://localhost:8080/swagger-ui.html ,可以看到swagger的界面;

配置Swagger

  1. Swagger实例Bean是Docket,所以通过配置Docket实例来配置Swaggger。
  1. @Bean //配置docket以配置Swagger具体参数
  2. public Docket docket() {
  3. return new Docket(DocumentationType.SWAGGER_2);
  4. }
  1. 可以通过apiInfo()属性配置文档信息
  1. //配置文档信息
  2. private ApiInfo apiInfo() {
  3. Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
  4. return new ApiInfo(
  5. "Swagger学习", // 标题
  6. "学习演示如何配置Swagger", // 描述
  7. "v1.0", // 版本
  8. "http://terms.service.url/组织链接", // 组织链接
  9. contact, // 联系人信息
  10. "Apach 2.0 许可", // 许可
  11. "许可链接", // 许可连接
  12. new ArrayList<>()// 扩展
  13. );
  14. }
  1. Docket 实例关联上 apiInfo()
  1. @Bean
  2. public Docket docket() {
  3. return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
  4. }
  1. 重启项目,访问测试 http://localhost:8080/swagger-ui.html 看下效果;

配置扫描接口

  1. 构建Docket时通过select()方法配置怎么扫描接口。
  1. @Bean
  2. public Docket docket() {
  3. return new Docket(DocumentationType.SWAGGER_2)
  4. .apiInfo(apiInfo())
  5. .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
  6. .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
  7. .build();
  8. }
  1. 重启项目测试,由于我们配置根据包的路径扫描接口,所以我们只能看到一个类

  2. 除了通过包路径配置扫描接口外,还可以通过配置其他方式扫描接口,这里注释一下所有的配置方式:

  1. any() // 扫描所有,项目中的所有接口都会被扫描到
  2. none() // 不扫描接口
  3. // 通过方法上的注解扫描,如withMethodAnnotation(GetMapping.class)只扫描get请求
  4. withMethodAnnotation(final Class<? extends Annotation> annotation)
  5. // 通过类上的注解扫描,如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
  6. withClassAnnotation(final Class<? extends Annotation> annotation)
  7. basePackage(final String basePackage) // 根据包路径扫描接口
  1. 除此之外,我们还可以配置接口扫描过滤:
  1. @Bean
  2. public Docket docket() {
  3. return new Docket(DocumentationType.SWAGGER_2)
  4. .apiInfo(apiInfo())
  5. .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
  6. .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
  7. // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
  8. .paths(PathSelectors.ant("/kuang/**"))
  9. .build();
  10. }
  1. 这里的可选值还有
  1. any() // 任何请求都扫描
  2. none() // 任何请求都不扫描
  3. regex(final String pathRegex) // 通过正则表达式控制
  4. ant(final String antPattern) // 通过ant()控制

配置Swagger开关

  1. 通过enable()方法配置是否启用swagger,如果是false,swagger将不能在浏览器中访问了
  1. @Bean
  2. public Docket docket() {
  3. return new Docket(DocumentationType.SWAGGER_2)
  4. .apiInfo(apiInfo())
  5. .enable(false) //配置是否启用Swagger,如果是false,在浏览器将无法访问
  6. .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
  7. .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
  8. // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
  9. .paths(PathSelectors.ant("/kuang/**"))
  10. .build();
  11. }
  1. 如何动态配置当项目处于test、dev环境时显示swagger,处于prod时不显示?
  1. @Bean
  2. public Docket docket(Environment environment) {
  3. // 设置要显示swagger的环境
  4. Profiles of = Profiles.of("dev", "test");
  5. // 判断当前是否处于该环境
  6. // 通过 enable() 接收此参数判断是否要显示
  7. boolean b = environment.acceptsProfiles(of);

  8. return new Docket(DocumentationType.SWAGGER_2)
  9. .apiInfo(apiInfo())
  10. .enable(b) //配置是否启用Swagger,如果是false,在浏览器将无法访问
  11. .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
  12. .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
  13. // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
  14. .paths(PathSelectors.ant("/kuang/**"))
  15. .build();
  16. }
  1. 可以在项目中增加一个dev的配置文件查看效果!

配置API分组

  1. 如果没有配置分组,默认是default。通过groupName()方法即可配置分组:
  1. @Bean
  2. public Docket docket(Environment environment) {
  3. return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
  4. .groupName("hello") // 配置分组
  5. // 省略配置....
  6. }
  1. 重启项目查看分组

  2. 如何配置多个分组?配置多个分组只需要配置多个docket即可:

  1. @Bean
  2. public Docket docket1(){
  3. return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
  4. }
  5. @Bean
  6. public Docket docket2(){
  7. return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
  8. }
  9. @Bean
  10. public Docket docket3(){
  11. return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
  12. }
  1. 重启项目查看即可

实体配置

  1. 新建一个实体类
  1. @ApiModel("用户实体")
  2. public class User {
  3. @ApiModelProperty("用户名")
  4. public String username;
  5. @ApiModelProperty("密码")
  6. public String password;
  7. }
  1. 只要这个实体在请求接口的返回值上(即使是泛型),都能映射到实体项中:
  1. @RequestMapping("/getUser")
  2. public User getUser(){
  3. return new User();
  4. }
  1. 重启查看测试

注:

  • 并不是因为@ApiModel这个注解让实体显示在这里了,而是只要出现在接口方法的返回值上的实体都会显示在这里,而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。

  • @ApiModel为类添加注释

  • @ApiModelProperty为类属性添加注释

常用注解

Swagger的所有注解定义在io.swagger.annotations包下

下面列一些经常用到的,未列举出来的可以另行查阅说明:

Swagger注解简单说明
@Api(tags = "xxx模块说明")作用在模块类上
@ApiOperation("xxx接口说明")作用在接口方法上
@ApiModel("xxxPOJO说明")作用在模型类上:如VO、BO
@ApiModelProperty(value = "xxx属性说明",hidden = true)作用在类方法和属性上,hidden设置为true可以隐藏该属性
@ApiParam("xxx参数说明")作用在参数、方法和字段上,类似@ApiModelProperty

我们也可以给请求的接口配置一些注释:

  1. @ApiOperation("狂神的接口")
  2. @PostMapping("/kuang")
  3. @ResponseBody
  4. public String kuang(@ApiParam("这个名字会被返回")String username){
  5. return username;
  6. }

这样的话,可以给一些比较难理解的属性或者接口,增加一些配置信息,让人更容易阅读!

相较于传统的Postman或Curl方式测试接口,使用swagger简直就是傻瓜式操作,不需要额外说明文档(写得好本身就是文档)而且更不容易出错,只需要录入数据然后点击Execute,如果再配合自动化框架,可以说基本就不需要人为操作了。

Swagger是个优秀的工具,现在国内已经有很多的中小型互联网公司都在使用它,相较于传统的要先出Word接口文档再测试的方式,显然这样也更符合现在的快速迭代开发行情。当然了,提醒下大家在正式环境要记得关闭Swagger,一来出于安全考虑二来也可以节省运行时内存。

拓展:其他皮肤

我们可以导入不同的包实现不同的皮肤定义:

  1. 默认的 访问 http://localhost:8080/swagger-ui.html
  1. <dependency>
  2. <groupId>io.springfox</groupId>
  3. <artifactId>springfox-swagger-ui</artifactId>
  4. <version>2.9.2</version>
  5. </dependency>

  1. bootstrap-ui 访问 http://localhost:8080/doc.html
  1. <!-- 引入swagger-bootstrap-ui包 /doc.html-->
  2. <dependency>
  3. <groupId>com.github.xiaoymin</groupId>
  4. <artifactId>swagger-bootstrap-ui</artifactId>
  5. <version>1.9.1</version>
  6. </dependency>

  1. Layui-ui 访问 http://localhost:8080/docs.html
  1. <!-- 引入swagger-ui-layer包 /docs.html-->
  2. <dependency>
  3. <groupId>com.github.caspar-chen</groupId>
  4. <artifactId>swagger-ui-layer</artifactId>
  5. <version>1.1.3</version>
  6. </dependency>

  1. mg-ui 访问 http://localhost:8080/document.html
  1. <!-- 引入swagger-ui-layer包 /document.html-->
  2. <dependency>
  3. <groupId>com.zyplayer</groupId>
  4. <artifactId>swagger-mg-ui</artifactId>
  5. <version>1.0.6</version>
  6. </dependency>


本文转载自狂神说的博客,感谢狂神开源的视频及资料。