狂神说SpringBoot14：集成Swagger终极版

不念不忘少年蓝@ 2021-09-24 09:54 357阅读 0赞

> 狂神说SpringBoot系列连载课程，通俗易懂，基于SpringBoot2.2.5版本，欢迎各位狂粉转发关注学习。未经作者授权，禁止转载

![format_png][]

项目集成Swagger

![format_png 1][]

**学习目标：**

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

<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，测试确保运行成功！

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

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

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

![format_png 2][]

> ### 配置Swagger ###

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

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

2、可以通过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()

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

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

> ### 配置扫描接口 ###

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

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

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、除此之外，我们还可以配置接口扫描过滤：

5、这里的可选值还有

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

![format_png 3][]

## ##

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

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

![format_png 4][]

> ### 配置API分组 ###

![format_png 5][]

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

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

2、重启项目查看分组

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、重启项目查看即可

> ### 实体配置 ###

1、新建一个实体类

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

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

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

3、重启查看测试

![format_png 6][]

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

@ApiModel为类添加注释

@ApiModelProperty为类属性添加注释

> ### 常用注解 ###

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

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

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

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

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

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

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

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

> ### 拓展：其他皮肤 ###

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

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

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

![format_png 7][]

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

<dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>swagger-bootstrap-ui</artifactId>
        <version>1.9.1</version>
    </dependency>

![format_png 8][]

3、Layui-ui   **访问 http://localhost:8080/docs.html**

<dependency>
        <groupId>com.github.caspar-chen</groupId>
        <artifactId>swagger-ui-layer</artifactId>
        <version>1.1.3</version>
    </dependency>

![format_png 9][]

4、mg-ui   **访问 http://localhost:8080/document.html**

<dependency>
        <groupId>com.zyplayer</groupId>
        <artifactId>swagger-mg-ui</artifactId>
        <version>1.0.6</version>
    </dependency>

![format_png 10][]

--------------------

狂神讲解的配套视频地址：https://www.bilibili.com/video/BV1Y441197Lw

视频同步更新，这次一定！

![format_png 11][]

![format_png 12][]

[format_png]: /images/20210923/e77e44f238bb4b48a608012c8583c737.png
[format_png 1]: /images/20210923/88306c7d45aa46de961d7d3e5fe3dc15.png
[format_png 2]: /images/20210923/c575e33cb8c647c8ab77837ffc2c9551.png
[format_png 3]: /images/20210923/39769ca36d914e82a15eb2a9f6aa23e9.png
[format_png 4]: /images/20210923/8e4d276f8bc54cba8cd42d4ec0ea7edf.png
[format_png 5]: /images/20210923/1b4af318ecf34763bc82659ccec55869.png
[format_png 6]: /images/20210923/2cacc85c91b34a44bf7ae1ac89621831.png
[format_png 7]: /images/20210923/8da71039061044648c4e016efcca4e5e.png
[format_png 8]: /images/20210923/fea55a5b7b1f4985a5435fa72c06d894.png
[format_png 9]: /images/20210923/9facda9b372a4b66ae7a775edb68cccb.png
[format_png 10]: /images/20210923/f88e7af54fa649f9a4ff43fd12b21ac0.png
[format_png 11]: /images/20210923/3ed297776dfc4a8c80290f74d70255f1.png
[format_png 12]: /images/20210923/e296af97c9e049f4840fb2a4c418f670.png