SpringBoot集成Swagger-02

SpringBoot集成Swagger-02

第一部分 swagger环境配置 请点击 链接: [swagger]
(https://blog.csdn.net/weixin_48321825/article/details/121565224?spm=1001.2014.3001.5501/).

一、配置扫描接口

1、构建Docket时通过select()方法配置怎么扫描接口。

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                //用了select就必须有build，加上build后，回去发现select就剩两个方法,apis和paths
                //basePackage: 指定要扫描的包
                //any()全部扫描 ， none()都不扫描
                .apis(RequestHandlerSelectors.basePackage("com.swagger.study.controller") )
                .build();
    }

2、重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能看到一个类
basic-error-controller 就被过滤掉了。

3、除了通过包路径配置扫描接口外，还可以通过配置其他方式扫描接口，这里注释一下所有的配置方式：

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

5、这里的可选值还有

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

二、 配置Swagger开关

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

@Bean
public Docket docket() {
  return new Docket(DocumentationType.SWAGGER_2)
     .apiInfo(apiInfo())
     .enable(false) //配置是否启用Swagger，如果是false，在浏览器将无法访问
     .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
     .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
      // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
     .paths(PathSelectors.ant("/kuang/**"))
     .build();
}

2、如何使Swagger在生产环境中使用，发布时不使用？

@Bean
   public Docket docket(Environment environment){

       //设置要显示的 Swagger环境
       Profiles profiles = Profiles.of("dev");

       //通过environment.acceptsProfiles 判断是否处在自己设定的环境当中
       boolean flag = environment.acceptsProfiles(profiles);


       return new Docket(DocumentationType.SWAGGER_2)
               .apiInfo(apiInfo())
               .enable(flag)
               .select()               .apis(RequestHandlerSelectors.basePackage("com.swagger.study.controller") )
               .build();
   }

3、可以在项目中增加一个test的配置文件查看效果！

三、配置API分组

1、如果没有配置分组，默认是default。通过groupName()方法即可配置分组：

@Bean
public Docket docket(Environment environment) {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
      .groupName("铁甲小宝") // 配置分组
       // 省略配置....
}

2、重启项目查看分组

3、如何配置多个分组？配置多个分组只需要配置多个docket即可：

@Bean
public Docket docket1(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("A");
}
@Bean
public Docket docket2(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("B");
}
@Bean
public Docket docket3(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("C");
}
@Bean
public Docket docket3(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("D");
}

4、重启项目查看即可

每一对应一个界面，每个认可能有自己的组，对应自己组查看自己写的接口

四、实体配置

1、新建一个实体类

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

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

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

3、重启查看测试


注：并不是因为@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

@ApiOperation：

    @ApiOperation("Hello控制类")
    @GetMapping(value = "/hello")
    public String hello(){
        return "hello";
    }


    //只要接口中返回值存在实体类，就会被扫描到Swagger中
    @PostMapping(value = "/user")
    public User user(){
        return new User();
    }

@ApiParam

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

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

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