SpringBoot集成Swagger

阅读量 ：
如需转载，请根据 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 许可，附上本文作者及链接。
本文作者： Alice
作者昵称： 沉。
本文链接： http://example.com/2020/11/17/SpringBoot%E9%9B%86%E6%88%90Swagger/

Finished：2020-11-17

十三、Swagger

学习目标：

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

image-20201117162051282

13.1、Swagger简介

前后端分离

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

产生的问题

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

解决方案

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

Swagger

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

13.2、SpringBoot集成Swagger

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

  • Springfox-swagger2
  • swagger-springmvc

使用Swagger

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

步骤：

1、新建一个SpringBoot-web项目

2、添加Maven依赖

1
2
3
4
5
6
7
8
9
10
11
12
<!-- 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

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

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

image-20201117170234314

13.3、配置Swagger

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
//配置Swagger信息=apiInfo
    private ApiInfo apiInfo(){
        Contact contact = new Contact("chen", "https://mad-chen.github.io/", "1405994298@qq.com");

        return new  ApiInfo(
                "chen的Swagger日记",
                "这个作者喜欢小仙女",
                "1.0",
                "https://mad-chen.github.io/",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());

    }

3、Docket 实例关联上 apiInfo()

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

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

image-20201117172537193

13.4、配置扫描接口

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
//配置了Swagger的Docket的实例
@Bean
public Docket docker(){
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .enable(false)//enable是否启动Swagger，如果为false，则Swagger不能在浏览器中访问
            .select()  //basePackage 指定要扫描的包  any（）：扫描全部 none（）：都不扫描
                        //withClassAnnotation（Annotation.class）:扫描类上的注解，参数是一个注解的反射对象
                        //withMethodAnnotation:扫描方法上的注解
                        //配置要扫描接口的方式
            .apis(RequestHandlerSelectors.basePackage("com.chen.controller"))
            //paths()：过滤什么路径
            .paths(PathSelectors.ant("/chen/**"))
            .build(); //工厂模式
}

2、重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能看到一个类

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

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

1
2
3
4
5
6
7
8
9
10
@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、这里的可选值还有

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

问题：我只希望我的Swagger在生产环境中使用，在发布的时候不使用

  • 判断是不是生产环境 flag = false
  • 注入enable（flag）
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
//配置了Swagger的Docket的实例
   @Bean
   public Docket docker(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(flag)//enable是否启动Swagger，如果为false，则Swagger不能在浏览器中访问
               .select()  //basePackage 指定要扫描的包  any（）：扫描全部 none（）：都不扫描
                           //withClassAnnotation（Annotation.class）:扫描类上的注解，参数是一个注解的反射对象
                           //withMethodAnnotation:扫描方法上的注解
                           //配置要扫描接口的方式
               .apis(RequestHandlerSelectors.basePackage("com.chen.controller"))
               //paths()：过滤什么路径
               .paths(PathSelectors.ant("/chen/**"))
               .build(); //工厂模式
   }

13.5、配置API文档分组

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

1
.groupName("chen")//分组

2、重启项目查看分组

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

1
2
3
4
5
6
7
8
9
10
11
//配置多个分组
public  Docket docket1(){
    return new Docket(DocumentationType.SWAGGER_2).groupName("A");
}
public  Docket docket2(){
    return new Docket(DocumentationType.SWAGGER_2).groupName("B");
}

public  Docket docket3(){
    return new Docket(DocumentationType.SWAGGER_2).groupName("C");
}

4、重启项目查看即可

13.6、实体配置

1、新建一个实体类

1
2
3
4
5
6
7
@ApiModel("用户实体")
public class User {
    @ApiModelProperty("用户名")
    public String username;
    @ApiModelProperty("密码")
    public String password;
}

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

1
2
3
4
@RequestMapping("/getUser")
public User getUser(){
    return new User();
}

3、重启查看测试

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

@ApiModel为类添加注释

@ApiModelProperty为类属性添加注释

13.7、常用注解

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

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

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

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

1
2
3
4
5
6
@ApiOperation("chen")
@PostMapping("/chen")
@ResponseBody
public String kuang(@ApiParam("这个名字会被返回")String username){
    return username;
}

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

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

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

拓展：其他皮肤

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

1
2
3
4
5
<dependency> 
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

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

1
2
3
4
5
6
<!-- 引入swagger-bootstrap-ui包 /doc.html-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.1</version>
</dependency>

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

1
2
3
4
5
6
<!-- 引入swagger-ui-layer包 /docs.html-->
<dependency>
    <groupId>com.github.caspar-chen</groupId>
    <artifactId>swagger-ui-layer</artifactId>
    <version>1.1.3</version>
</dependency>

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

1
2
3
4
5
6
<!-- 引入swagger-ui-layer包 /document.html-->
<dependency>
    <groupId>com.zyplayer</groupId>
    <artifactId>swagger-mg-ui</artifactId>
    <version>1.0.6</version>
</dependency>

Swagger是一个优秀的工具，几乎所有大公司都有使用它

【注意点】：在正式发布的时候，关闭swagger，否则会暴露接口，不安全



-------------本文结束感谢您的阅读-------------



本文作者： Alice
本文链接： http://example.com/2020/11/17/SpringBoot%E9%9B%86%E6%88%90Swagger/
版权声明： 本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。转载请注明出处！
知识共享许可协议
赏

谢谢你请我吃糖果

支付宝
微信

扫一扫，分享到微信

微信分享二维码

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

恭喜你，发现了一个宝藏男孩