17、SpringBoot：集成Swagger

学习目标：

• 了解Swagger的概念及作用
• 掌握在项目中集成Swagger自动生成API文档

16.1、Swagger简介

前后端分离

• 前端 -> 前端控制层、视图层
• 后端 -> 后端控制层、服务层、数据访问层
• 前端通过API进行交互
• 前后端相对独立且松耦合

产生的问题

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

解决方案

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

Swagger

• 号称世界上最流行的API框架
• Restful Api 文档在线自动生成器 =》 API文档与API定义同步更新
• 直接运行，在线测试API
• 支持多种语言（如：Java，PHP等）
• 官网：https://swagger.io/

16.2、SpringBoot集成Swagger

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

• Springfox-swagger2
• swagger-springmvc

使用Swagger

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

步骤：

1. 新建一个SpringBoot-Web项目
2. 导入相关依赖

<!-- 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>

注意：这里导入高版本的有可能会出错

3. 编写HelloController，测试确保运行成功！
4. 要使用Swagger，我们需要编写一个配置类-SwaggerConfig来配置Swagger

@Configuration
@EnableSwagger2    //开启Swagger2
public class SwaggerConfig {

}

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

16.3、配置Swagger

1.Swagger实例Bean时Docket，所以通过配置Docket实例来配置Swagger。

 //配置Swagger的docket示例
 @Bean
 public Docket docket(){
     return new Docket(DocumentationType.SWAGGER_2);
 }

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

//配置Swagger信息=aipInfo
private ApiInfo apiInfo(){

    //作者信息
    Contact contact = new Contact("Tony", "https://blog.csdn.net/cxycxytony", "984685122@qq.com");

    return  new ApiInfo(
            "Tony的SwaggerAPI文档", // 标题
            "即使再小的帆也能远航", // 描述 
            "1.0", // 版本
            "https://blog.csdn.net/cxycxytony", // 组织链接
            contact, // 联系人信息
            "Apache 2.0", // 许可
            "http://www.apache.org/licenses/LICENSE-2.0", // 许可链接
            new ArrayList()// 扩展
    ); 
}

3.在Docket实例关联上apiInfo()

@Bean
public Docket docket(){
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo());
}

4.重启项目，访问呢测试 http://localhost:8080/swagger-ui.html 看下效果

16.4、配置扫描接口

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

  @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()//通过select方法，去配置扫描接口
                //RequestHandlerSelectors,配置要扫描的方式
				//basePackage:指定要扫描的包
                .apis(RequestHandlerSelectors.basePackage("com.chen.swagger.controller"))
                .build();
    }

2. 重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能得到一个类
3. 除了通过包路径配置扫描接口外，还可以通过配置其他方式扫描接口，这里注释一下所有的配置方式

// 指定要扫描的包
basePackage(final String basePackage)
// 如：basePackage("com.chen.swagger.controller")

// 扫描全部
any(): 

// 都不扫描
none():

// 扫描类上的注解，参数是一个注解的反射对象
withClassAnnotation(final Class<? extends Annotation> annotation): 
//如：withClassAnnotation(Controller.class) 只扫描有controller注解的类的接口

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

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

@Bean
public Docket docket(){
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.chen.swagger.controller"))
            //paths():过滤什么请求路径，即这里只扫描请求以以/chen开头的接口
            .paths(PathSelectors.ant("/chen/**"))
            .build();
}

5. 这里的可选值还有

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

16.5、配置开关

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

@Bean
public Docket docket(){
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            //enable:是否启动Swagger，如果为false，则Swagger不能在浏览器中访问
            .enable(false)
            .select()
            //RequestHandlerSelectors,配置要扫描的方式
            .apis(RequestHandlerSelectors.basePackage("com.chen.swagger.controller"))
            //paths():过滤什么请求路径
            .paths(PathSelectors.ant("/chen/**"))
            .build();
}

2. 如何动态配置当项目处于test、dev环境时显示swagger，处于prod时不显示？

//配置Swagger的docket示例
@Bean
public Docket docket(Environment environment){

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

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

    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            //enable:是否启动Swagger，如果为false，则Swagger不能在浏览器中访问
            .enable(flag)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.chen.swagger.controller"))
            .paths(PathSelectors.ant("/chen/**"))
            .build();
}

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

16.6、配置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");
    }

4. 重启项目查看即可
   

16.7、实体配置

1. 新建一个实体类

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

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

 //只要我们的接口中，返回值中存在实体类，他就会被扫描到swagger中
 @RequestMapping("/user")
 public User user(){
     return new User();
 }

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

@ApiModel 为类添加注释

@ApiModelProperty 为属性添加注释

补充：如果实体类的属性是public，swagger可以直接拿到，如果是private，则必须加get/set方法，否则swapper拿不到

16.8、常用注解

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

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

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

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

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

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

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

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

16.9、拓展：其他皮肤

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

1. 默认的 访问 http://localhost:8080/swagger-ui.html

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

2. bootstrap-ui 访问 http://localhost:8080/doc.html

<!-- 引入swagger-bootstrap-ui包 /doc.html-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.1</version>
</dependency>

3. mg-ui 访问 http://localhost:8080/document.html

<!-- 引入swagger-ui-layer包 /document.html-->
<dependency>
   <groupId>com.zyplayer</groupId>
   <artifactId>swagger-mg-ui</artifactId>
   <version>1.0.6</version>
</dependency>

学习视频链接：https://www.bilibili.com/video/BV1PE411i7CV?p=51