SpringBoot集成Swagger

1. Swagger

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

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

• 直接运行，在线测试API

• 支持多种语言 （如：Java，PHP等）

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

2. SpringBoot集成Swagger

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

• Springfox-swagger2

• swagger-springmvc

2.1 添加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>

2.2 编写配置类-SwaggerConfig来配置 Swagger

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {  
}

配置完成，访问测试 ：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；

3.配置Swagger

3.1 Swagger实例Bean是Docket，所以通过在配置类中配置Docket实例来配置Swaggger。

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {  

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2);
}

}

3.2 通过apiInfo()属性配置文档信息

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {  

......

//配置文档信息
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<>()// 扩展
  );
}
}

3.3 Docket 实例关联上 apiInfo()

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {  

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
              .apiInfo(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<>()// 扩展
  );
}
}

配置完成访问测试 http://localhost:8080/swagger-ui.html

4. 配置扫描接口

4.1 构建Docket时通过select()方法配置扫描那些接口

• select()方法，去配置扫描接口
• RequestHandlerSelectors配置如何扫描

  • any() 扫描所有，项目中的所有接口都会被扫描到

  • none() 不扫描接口

  • withMethodAnnotation(final Class<? extends Annotation> annotation)
    通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求

  • withClassAnnotation(final Class<? extends Annotation> annotation)
    通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口

  • basePackage(final String basePackage) / 根据包路径扫描接口

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.yanyu.swagger.controller"))
      .build();
}

4.2 配置接口扫描过滤

• 配置通过paths过滤
  • any() 任何请求都扫描
  • none() 任何请求都不扫描
  • regex(final String pathRegex) 通过正则表达式控制
  • ant(final String antPattern) 通过ant()控制

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.yanyu.swagger.controller"))
       // 只扫描请求以/yanyu开头的接口
      .paths(PathSelectors.ant("/yanyu/**"))
      .build();
}

5. 配置Swagger开关

5.1 通过enable()方法配置是否启用swagger，如果是false，swagger将不能在浏览器中访问了

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(false); //配置是否启用Swagger，如果是false，在浏览器将无法访问
}

5.2 动态配置当项目处于test、dev环境时显示swagger，处于prod时不显示

@Bean
public Docket docket(Environment environment) {
   // 设置要显示swagger的环境
   Profiles of = Profiles.of("dev", "test");
   // 判断当前是否处于该环境
   // 通过 enable() 接收此参数判断是否要显示
   boolean flag = environment.acceptsProfiles(of);
   
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(flag); //配置是否启用Swagger，如果是false，在浏览器将无法访问
}

6. 配置API分组

• 若没有配置分组，默认是default。
• 通过groupName()方法即可配置分组：

@Bean
public Docket docket(Environment environment) {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
      .groupName("hello")； // 配置分组
}

配置多个分组只需要配置多个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为类添加注释

• @ApiModelProperty为类属性添加注释

新建一个实体类

@ApiModel("用户实体")
public class User {
   @ApiModelProperty("用户名")
   public String username;
   @ApiModelProperty("密码")
   public String password;
}

只要这个实体在请求接口的返回值上（即使是泛型），都能映射到实体项中：

@RequestMapping("/getUser")
public User getUser(){
   return new User();
}

常用注解

• @Api(tags = “xxx模块说明”) 作用在模块类上
• @ApiOperation(“xxx接口说明”) 作用在接口方法上
• @ApiModel(“xxxPOJO说明”) 作用在模型类上：如VO、BO
• @ApiModelProperty(value = “xxx属性说明”,hidden = true) 作用在类方法和属性上，hidden设置为- true可以隐藏该属性
• @ApiParam(“xxx参数说明”) 作用在参数、方法和字段上，类似@ApiModelProperty