SpringBoot集成Swagger、配置Swagger、配置扫描接口、配置Swagger开关、配置API分组、实体配置、常用注解

灰太狼 2022-12-09 04:55 163阅读 0赞

# Swagger简介 #

**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依赖

<dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger2</artifactId>
       <version>2.9.2</version>
    </dependency>
    
    <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger-ui</artifactId>
       <version>2.9.2</version>
    </dependency>

3、编写HelloController，测试确保运行成功

@RestController
    public class hello { 
    
        @RequestMapping(value = "/hello")
        public String hello(){ 
            return "hello";
        }
    }

4、要使用Swagger，我们需要编写一个配置类-SwaggerConfig来配置 Swagger

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

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

# 配置Swagger #

1、Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

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

2、可以通过apiInfo()属性配置文档信息

//推荐ApiInfoBuilder()：
    private ApiInfo apiInfo() { 
            return new ApiInfoBuilder()
                    .title("服务:发布为daocke镜像,权限管理，用户管理，页面管理，日志 后台 APIs")
                    .description("服务:发布为daocke镜像,权限管理，用户管理，页面管理，日志 后台")
                    .termsOfServiceUrl("http://baidu.com")
                    .contact("程序猿")
                    .version("1.0")
                    .build();
        }
    
    
    //下面的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<>()// 扩展
      );
    }

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() { 
            return new ApiInfoBuilder()
                    .title("服务:发布为daocke镜像,权限管理，用户管理，页面管理，日志 后台 APIs")
                    .description("服务:发布为daocke镜像,权限管理，用户管理，页面管理，日志 后台")
                    .termsOfServiceUrl("http://baidu.com")
                    .contact("程序猿")
                    .version("1.0")
                    .build();
        }
    
    
        //配置文档信息 已过时--------------------------用上面的builder
        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<>()// 扩展
            );
        }
    }

4、重启项目，访问测试 `http://localhost:8080/swagger-ui.html` 看下效果；  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70]

# 配置扫描接口 #

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

@Bean //配置docket以配置Swagger具体参数
    public Docket docket() { 
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
            	// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                .apis(RequestHandlerSelectors.basePackage("com.lyh.controller"))
                        //basePackage指定扫描的包
                        //any()扫描全部
                        //none()不扫描
                        //withClassAnnotation扫描类上的注解
                        //withMethodAnnotation扫描方法上的注解
                .build();
    }

2、重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能看到一个类  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70 1]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70 2]

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

any() // 扫描所有，项目中的所有接口都会被扫描到
    none() // 不扫描接口
        
    // 通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
    withMethodAnnotation(final Class<? extends Annotation> annotation)
        
    // 通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
    withClassAnnotation(final Class<? extends Annotation> annotation)
    
    // 根据包路径扫描接口
    basePackage(final String basePackage)

4、除此之外，我们还可以配置接口扫描过滤：

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

2、如何动态配置当项目处于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.lyh.controller"))
           // 配置如何通过path过滤,即这里只扫描请求以/lyh开头的接口
          .paths(PathSelectors.ant("/lyh/**"))
          .build();
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70_pic_center]

# 配置API分组 #

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

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

2、重启项目查看分组

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70_pic_center 1][]

3、如何配置多个分组？配置多个分组只需要配置多个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");
    }

4、重启项目查看即可

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70_pic_center 2]

# 实体配置 #

1、新建一个实体类

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

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

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

3、重启查看测试

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70_pic_center 3]

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

`@ApiModel`为类添加注释

`@ApiModelProperty`为类属性添加注释

# 常用注解 #

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

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

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

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

@ApiOperation("我的接口")
    @PostMapping("/lyh")
    @ResponseBody
    public String lyh(@ApiParam("这个名字会被返回")String username){ 
       return username;
    }

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

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

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

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70]: /images/20221123/6e9d55530fcf4609be461d117686e77e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70 1]: /images/20221123/7e256c13f34745e9ab2a658defb5ebf2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70 2]: /images/20221123/79febc1d68e5440aae94e7a323939c69.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/e66a2ae6f41c492f96f0d794b85580c9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/3cde40b48eed4efebfee1406a2c58f57.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/63fb3754e5f24035b0f6b966570bfa59.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNDcyODc3_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221123/a4807f02a8a14e87a2c38802772e2e0f.png