SpringBoot-16-Swagger

字数统计: 2.2k字   |   阅读时长≈ 9分钟

SpringBoot-16-Swagger

1. Swagger 简介

1.1 前后端分离

问题描述

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

这样会产生的问题：

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

解决方法：

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

Swagger:

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

2. 项目中集成Swagger

2.1 环境搭建

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

  • Springfox-swagger2
  • swagger-springmvc

1. 使用Swagger

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

步骤：

  1. 新建一个Springboot-web项目

  2. 添加Maven依赖

1
2
3
4
5
6
7
8
9
10
11
12
13
<!--Swagger jar 包-->
<!-- 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>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
  1. 编写helloController,确保测试环境可以成功
  2. 要使用Swagger,需要编写config/SwaggerConfig.java
1
2
3
4
@Configuration   //配置类
@EnableSwagger2  // 开启Swagger2的自动配置
public class SwaggerConfig {  
}
  1. 访问 ：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；

2.2 swagger 初使用

  1. Swagger的Bean实例是Docket，所以通过配置Docket来配置Swagger

    (config/SwaggerConfig.java)

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

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

    (config/SwaggerConfig.java)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
//配置文档信息
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<>()// 扩展
  );
}

  1. Docket实例连接apiInfo()

    (config/SwaggerConfig.java)

1
2
3
4
@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}
  1. 重启项目，访问测试 http://localhost:8080/swagger-ui.html

2.3 配置扫描接口

  1. 构建Docket时通过select()方法配置怎么扫描接口。
1
2
3
4
5
6
7
8
@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.zhuuu.swagger.controller"))
      .build();
}
  1. 除了通过包路径配置扫描接口外，还可以通过配置其他方式扫描接口，这里注释一下所有的配置方式：
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) // 根据包路径扫描接口
  1. 除此之外还可以配置接口扫描过滤
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.zhuuu.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/zhuuu开头的接口
      .paths(PathSelectors.ant("/zhuuu/**"))
      .build();
}
  • 这里的可选值还有：
1
2
3
4
any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

2.4 配置 Swagger开关

  1. 通过enable()方法配置是否启用swagger，如果是false，swagger将不能在浏览器中访问了
1
2
3
4
5
6
7
8
9
10
11
@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(false) //配置是否启用Swagger，如果是false，在浏览器将无法访问
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.zhuuu.swagger.controller"))
       // 配置如何通过path过滤
      .paths(PathSelectors.ant("/zhuuu/**"))
      .build();
}
  1. 如何动态配置当项目处于test、dev环境时显示swagger，处于product时不显示？
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
    // 配置Swagger的bean实例
    @Bean
    public Docket docket(Environment environment){


        // 获取项目的环境：
        // 设置要显示的swagger环境
        Profiles profiles = Profiles.of("dev","test");
        // 通过环境监听的变量，判断自己是否在环境中
        boolean flag = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("zhuuu")
                // enable : 是否启用swagger，如果为False，则swagger不能再浏览器中访问
                .enable(flag)
                .select()      		.apis(RequestHandlerSelectors.basePackage("com.zhuuu.swagger.controller"))
                // 过滤什么路径
//                .paths(PathSelectors.ant("/zhuuu/**"))
                .build();
    }

2.5 配置API 多分组

  1. 如果没有配置分组，默认是default。通过groupName()方法即可配置分组：
1
2
3
4
5
6
@Bean
public Docket docket(Environment environment) {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
      .groupName("hello") // 配置分组
       // 省略配置....
}
  1. 重启项目查看分组
  2. 配置多套分组，只需要配置多个docket即可
1
2
3
4
5
6
7
8
9
10
11
12
@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");
}

2.6 注解操作

  1. pojo包下新建一个User.java
1
2
3
4
5
6
7
@ApiModel("用户实体")
public class User {
   @ApiModelProperty("用户名")
   public String username;
   @ApiModelProperty("密码")
   public String password;
}
  1. 只要这个实体类在请求接口的返回值上（即使是泛型），都能映射到实体项中
1
2
3
4
@RequestMapping("/getUser")
public User getUser(){
   return new User();
}

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

  • @ApiModel为类添加注释

  • @ApiModelProperty为类属性添加注释

2.7 常用注解

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

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

Swagger注解 简单说明
@Api(tags = “xxx模块说明”) 作用在模块类上
@ApiOperation(“xxx接口说明”) 作用在controller对外接口方法上
@ApiModel(“xxxPOJO说明”) 作用在模型类上：如VO、BO
@ApiModelProperty(value = “xxx属性说明”,hidden = true) 作用在类方法和属性上，hidden设置为true可以隐藏该属性
@ApiParam(“xxx参数说明”) 作用在参数、方法和字段上，类似@ApiModelProperty
  1. 可以在Controller接口上添加注释
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
@RestController
public class HelloController {

    @GetMapping(value = "/hello")
    public String hello(){
        return "hello";
    }


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


    // @ApiOperation: 放在方法上
    @ApiOperation("hello控制")
    @GetMapping("/hello2")
    public String hello2(@ApiParam("用户名") String username){
        return "hello" + username;
    }


    // @ApiOperation: 放在方法上
    @ApiOperation("post测试")
    @PostMapping("/postt")
    public User hello2(@ApiParam("用户名") User user){
        return user;
    }
}

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

2.8 拓展：更换皮肤

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

  1. 默认的皮肤
1
2
3
4
5
<dependency> 
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>
  1. 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>

  1. 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>
  1. 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>

3. 常用注解示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
@Api() ：用于类；表示标识这个类(往往是controller)是swagger的资源，tags–表示说明
    @Api(tags="用户模块")
    public class UserController { }
 
@ApiOperation：用于对一个操作或HTTP方法进行描述
    @ApiOperation(notes = "查询用户",value = "查询用户")
    public User getUser(){}
 
@ApiParam：用于请求方法上，定义api参数的注解
    public User getUser(@ApiParam("用户id")Integer id){}
 
@ApiModel()：用于类 ；表示对类进行说明，用于参数用实体类接收 
    @ApiModel("用户对象user")
    public class User{}
 
@ApiModelProperty:用来描述一个Model的属性
    @ApiModelProperty(value = "提示信息")
	private String message;
打赏
  • 版权声明： 本博客所有文章除特别声明外，均采用 Apache License 2.0 许可协议。转载请注明出处！
  • © 2019-2022 Zhuuu
  • PV: UV:

请我喝杯咖啡吧~

支付宝
微信