Swagger-的使用 +Swagger-UI添加请求头

逃离我推掉我的手 2023-09-26 23:18 104阅读 0赞

文章目录

  • 前言
  • 一、简介
  • 二、基本使用
      1. 导入相关依赖
      1. 编写配置文件
      • 2.1 配置基本信息
      • 2.2 配置接口信息
      • 2.3 配置分组信息
      1. 控制 Swagger 的开启
      1. 常用注解使用
      • @ApiModel
      • @ApiModelProperty
      • @ApiOperation
      • @ApiParam
      1. 接口调用
  • 三、进阶使用
      1. 添加请求头

    前言

    作为后端开放人员，最烦的事就是自己写接口文档和别人没有写接口文档，不管是前端还是后端开发，多多少少都会被接口文档所折磨，前端会抱怨后端没有及时更新接口文档，而后端又会觉得编写接口文档太过麻烦。Swagger 可以较好的接口接口文档的交互问题，以一套标准的规范定义接口以及相关的信息，就能做到生成各种格式的接口文档，生成多种语言和客户端和服务端的代码，以及在线接口调试页面等等。只需要更新 Swagger 描述文件，就能自动生成接口文档，做到前端、后端联调接口文档的及时性和便利性。

    一、简介

    官网：https://swagger.io/

    Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

    Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口，可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger 消除了调用服务时可能会有的猜测。

    Swagger 的优势

    • 支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便，可以节约写文档的时间去学习新技术。
    • 提供 Web 页面在线测试 API：光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。

    二、基本使用

    1. 导入相关依赖

    通过在项目中引入 Springfox，可以扫描相关的代码，生成该描述文件，进而生成与代码一致的接口文档和客户端代码。

    1.        <dependency>
    2.            <groupId>io.springfox</groupId>
    3.            <artifactId>springfox-spring-web</artifactId>
    4.            <version>2.9.2</version>
    5.        </dependency>
    6.        <dependency>
    7.            <groupId>io.springfox</groupId>
    8.            <artifactId>springfox-swagger2</artifactId>
    9.            <version>2.9.2</version>
    10.        </dependency>
    11.        <dependency>
    12.            <groupId>io.springfox</groupId>
    13.            <artifactId>springfox-swagger-ui</artifactId>
    14.            <version>2.9.2</version>
    15.        </dependency>

2. 编写配置文件

在配置文件 config 目录下，添加 swagger 的配置文件 SwaggerConfig.java

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

这个时候 Swagger 已经算是整合到项目之中了，可以启动下服务，输入：http://localhost:8080/swagger-ui.html# （这里我的项目端口是 8868 ，项目路径是 /mike，所以我打开的文档地址为 http://localhost:8868/mike/swagger-ui.html# ）即可查看 swagger 文档。

在这里插入图片描述
可以看到 Swagger 文档中大概有这四类信息

  • 组
  • 基本信息
  • 接口信息
  • 实体类信息

2.1 配置基本信息

Swagger 有自己的实例 Docket，如果我们想要自定义基本信息，可以使用 docket 来配置 swagger 的基本信息，基本信息的设置在 ApiInfo 这个对象中。

Swagger 默认的基本信息展示

在这里插入图片描述

ApiInfo 中默认的基本设置

  • title：Api Documentation
  • description：Api Documentation
  • version：1.0
  • termsOfServiceUrl：urn:tos
  • contact：无
  • license：Apache 2.0
  • licenseUrl：http://www.apache.org/licenses/LICENSE-2.0

SwaggerConfig.java 配置文件添加以下内容：

  1. @Bean
  2.     public Docket docket() {
  4.         // 创建一个 swagger 的 bean 实例
  5.         return new Docket(DocumentationType.SWAGGER_2)
  6.                 // 配置基本信息
  7.                 .apiInfo(apiInfo())
  8.                 ;
  9.     }
  11.     // 基本信息设置
  12.     private ApiInfo apiInfo() {
  14.         Contact contact = new Contact(
  15.                 "米大傻", // 作者姓名
  16.                 "https://blog.csdn.net/xhmico?type=blog", // 作者网址
  17.                 "777777777@163.com"); // 作者邮箱
  18.         return new ApiInfoBuilder()
  19.                 .title("多加辣-接口文档") // 标题
  20.                 .description("众里寻他千百度，慕然回首那人却在灯火阑珊处") // 描述
  21.                 .termsOfServiceUrl("https://www.baidu.com") // 跳转连接
  22.                 .version("1.0") // 版本
  23.                 .license("Swagger-的使用(详细教程)")
  24.                 .licenseUrl("https://blog.csdn.net/xhmico/article/details/125353535")
  25.                 .contact(contact)
  26.                 .build();
  27.     }

重启服务，打开 Swagger 文档，基本信息改变如下所示：

在这里插入图片描述

2.2 配置接口信息

默认情况下，Swagger 是会展示所有的接口信息的，包括最基础的 basic-error 相关的接口

在这里插入图片描述

有时候我们希望不要展示 basic-error-controller 相关的接口，或者是说这想要显示某些接口，比如说：user-controller 下的接口，由该怎么去实现呢？这个时候就需要设置 扫描接口

  1. @Bean
  2.     public Docket docket() {
  4.         // 创建一个 swagger 的 bean 实例
  5.         return new Docket(DocumentationType.SWAGGER_2)
  7.                 // 配置接口信息
  8.                 .select() // 设置扫描接口
  9.                 // 配置如何扫描接口
  10.                 .apis(RequestHandlerSelectors
  11.                         //.any() // 扫描全部的接口，默认
  12.                         //.none() // 全部不扫描
  13.                         .basePackage("com.duojiala.mikeboot.controller") // 扫描指定包下的接口，最为常用
  14.                         //.withClassAnnotation(RestController.class) // 扫描带有指定注解的类下所有接口
  15.                         //.withMethodAnnotation(PostMapping.class) // 扫描带有只当注解的方法接口
  17.                 )
  18.                 .paths(PathSelectors
  19.                         .any() // 满足条件的路径，该断言总为true
  20.                         //.none() // 不满足条件的路径，该断言总为false（可用于生成环境屏蔽 swagger）
  21.                         //.ant("/user/**") // 满足字符串表达式路径
  22.                         //.regex("") // 符合正则的路径
  23.                 )
  24.                 .build();
  25.     }

可根据自己的需求去设置对应的配置，这里我就不再一一赘述了，以上是我所设置的配置，重启服务，打开 Swagger 文档，接口信息改变如下所示：

在这里插入图片描述

可以看到之前 basic-error-controller 相关的接口已经没有了

2.3 配置分组信息

Swagger 默认只有一个 default 分组选项，如果没有设置，所有的接口都会显示在 default 分组下，如果功能模块和接口数量一多，就会显得比较凌乱，不方便查找和使用。

swagger 文档中组名默认是 default，可通过 .groupName(String )

在这里插入图片描述

  1. @Bean
  2.     public Docket docket() {
  4.         // 创建一个 swagger 的 bean 实例
  5.         return new Docket(DocumentationType.SWAGGER_2)
  6.                 .groupName("mike") // 修改组名为 "mike"
  7.                 ;
  8.     }

修改后：
在这里插入图片描述
如果需要配置多个组的话，就需要配置多个 docket() 方法，这里我就简单写两组，代码如下：

  1. /**
  2.      * 展示 controller 包下所有的接口
  3.      */
  4.     @Bean
  5.     public Docket docket1() {
  7.         // 创建一个 swagger 的 bean 实例
  8.         return new Docket(DocumentationType.SWAGGER_2)
  9.                 .groupName("mike") // 修改组名为 "mike"
  10.                 // 配置接口信息
  11.                 .select() // 设置扫描接口
  12.                 // 配置如何扫描接口
  13.                 .apis(RequestHandlerSelectors
  14.                         .basePackage("com.duojiala.mikeboot.controller") // 扫描指定包下的接口，最为常用
  15.                 )
  16.                 .paths(PathSelectors
  17.                          .any() // 满足条件的路径，该断言总为true
  18.                 )
  19.                 .build();
  20.     }
  22.     /**
  23.      * 展示路径为 /error 的所有接口（基础接口）
  24.      */
  25.     @Bean
  26.     public Docket docket2() {
  28.         // 创建一个 swagger 的 bean 实例
  29.         return new Docket(DocumentationType.SWAGGER_2)
  30.                 .groupName("yank") // 修改组名为 "yank"
  31.                 // 配置接口信息
  32.                 .select() // 设置扫描接口
  33.                 // 配置如何扫描接口
  34.                 .apis(RequestHandlerSelectors
  35.                         .any() // 扫描全部的接口，默认
  36.                 )
  37.                 .paths(PathSelectors
  38.                         .ant("/error") // 满足字符串表达式路径
  39.                 )
  40.                 .build();
  41.     }

重启服务，打开 Swagger 文档，接口信息改变如下所示：

组名为 mike 的文档中只有 user-controller 相关的接口信息

在这里插入图片描述

组名为 yank 的文档中只有 basic-error-controller 相关的接口信息

在这里插入图片描述

3. 控制 Swagger 的开启

在开发或者测试环境下，我们开启 swagger 会方便前端和后端的交互，但是如果在生产环境下也开启 swagger 的话，是会将接口暴露出去的，有极大风险，如何让 swagger 根据不同的环境来决定是否开启？

这里我准备了四个项目的配置文件，dev、test、pro 三个环境的配置文件仅是端口上的不同

在这里插入图片描述

  • application.yml ————————————— 全局配置文件
  • application-dev.yml —————————— 开发环境配置文件
  • application-test.yml —————————— 测试环境配置文件
  • application-pro.yml —————————— 生产环境配置文件

application.yml 内容如下，用于指定选择的环境：

  1. spring:
  2.   profiles:
  3.     active: dev

可以通过代码判断此时是在什么环境：dev、test、pro，如果是在 pro 生产环境，则关闭 swagger。

  1. /**
  2.      * swagger 配置
  3.      * @param environment 环境
  4.      */
  5.     @Bean
  6.     public Docket docket(Environment environment) {
  9.         // 设置环境范围
  10.         Profiles profiles = Profiles.of("dev","test");
  11.         // 如果在该环境返回内则返回：true，反之返回 false
  12.         boolean flag = environment.acceptsProfiles(profiles);
  14.         // 创建一个 swagger 的 bean 实例
  15.         return new Docket(DocumentationType.SWAGGER_2)
  16.                 .enable(flag) // 是否开启 swagger：true -> 开启，false -> 关闭
  17.                 ;
  18.     }

在 application.yml 全局配置文件中环境指向 dev 时，是可以打开 swagger 的

在这里插入图片描述
如果我将 application.yml 全局配置文件中环境指向 pro 时，就不能打开 swagger 了，提示 Could not render e, see the console

在这里插入图片描述

4. 常用注解使用

之前有说 Swagger 会将接口请求或者相应的实体类信息展示在 Models 下的，比如我 UserController.java 下有一个接口如下所示：

  1. @PostMapping(value = "/query-user-info")
  2.     public ResponseBean queryUserInfo(@RequestBody @Validated IdReq req) {
  4.         return ResponseBean.success(userService.queryUserInfo(req));
  5.     }

它的请求体是 IdReq，响应是 ResponseBean，Models 展示这两个实体类信息如下：

在这里插入图片描述
前端可通过看这个 Models 知道后端定义实体类的信息。

@ApiModel

该注解是作用于实体类上面的，是用来描述实体类的一些基本信息的。

相关属性：

  • value：提供类的一个备用名，如果不设置，默认情况下将使用 class 类的名称
  • description：对于类，提供一个详细的描述信息
  • parent：这个属性用于描述的是类的一些父类信息
  • discriminator：这个属性解释起来比较麻烦，因为这个类主要体现在断言当中
  • subTypes：可以通过这个属性，指定我们想要使用的子类

譬如：这个为给 IdReq 这个类添加该注解

  1. @Data
  2. @NoArgsConstructor
  3. @AllArgsConstructor
  4. @ApiModel(value = "Id请求体")
  5. public class IdReq {
  7.     private String id;
  8. }

在这里插入图片描述
可以看到这里的名字从 IdReq 变成 Id请求体 了

@ApiModelProperty

该注解是用在实体类的属性上的。它的作用是添加和操作属性模块的数据。

该注解的使用详情可参见博客：@ApiModelProperty注解的用法

这里我还是以 IdReq 类为例，为该类的属性添加说明

  1. @Data
  2. @NoArgsConstructor
  3. @AllArgsConstructor
  4. @ApiModel(value = "Id请求体")
  5. public class IdReq {
  7.     @ApiModelProperty("主键id")
  8.     private String id;
  9. }

在这里插入图片描述
可以看到这里对该字段有一个备注说明。

@ApiOperation

该注解是用在Controller类中的方法上的。用来对某个方法/接口进行描述

该注解的使用详情可参见博客：Swagger @ApiOperation 注解详解

这里我以 UserController 下的接口为例：

  1. @PostMapping(value = "/query-user-info")
  2.     @ApiOperation(value = "根据id查询用户详情")
  3.     public ResponseBean queryUserInfo(@RequestBody @Validated IdReq req) {
  5.         return ResponseBean.success(userService.queryUserInfo(req));
  6.     }

在这里插入图片描述
可以看见该接口就多了对其的描述信息。

@ApiParam

该注解是用在Controller类的方法上或者参数上，用来进行字段说明，表示对参数的添加元数据（说明或者是否必填等）

相关属性：

  • name：参数名
  • value：参数说明
  • required：是否必填

这里我以 UserController 下的接口为例：

  1. @PostMapping(value = "/query-user-infos")
  2.     @ApiOperation(value = "条件查询用户信息")
  3.     public ResponseBean queryUserInfos(
  4.             // name 用户名称 不必填
  5.             @ApiParam(value = "用户名称", required = false) @RequestParam(required = false) String name,
  6.             // gender 用户性别 必填
  7.             @ApiParam(value = "用户性别", required = true) @RequestParam(required = true) GenderEnum gender
  8.     ) {
  10.         return ResponseBean.success(userService.queryUserInfos(name,gender));
  11.     }

在这里插入图片描述
这里会展示请求参数的备注信息，以及是否必填等。

5. 接口调用

使用 swagger 除了让前后端交互变得方便，也让接口的请求变得简单，只需要填写好请求所需要的参数信息，便可直接发起请求。

比如说接口 /user/query-user-info

点击 Try it out

在这里插入图片描述
设置好请求所需的参数，点击 Execute 执行

在这里插入图片描述

就能看到接口响应的结果了

在这里插入图片描述

接口 /user/query-user-infos 也差不多

在这里插入图片描述
在这里插入图片描述

三、进阶使用

1. 添加请求头

有时候我们的接口是需要获取请求头信息的，这样的话就还需要在 swagger 配置中添加请求头的配置。

  1. @Bean
  2.     public Docket docket() {
  4.         // 设置请求头
  5.         List<Parameter> parameters = new ArrayList<>();
  6.         parameters.add(new ParameterBuilder()
  7.                 .name("token") // 字段名
  8.                 .description("token") // 描述
  9.                 .modelRef(new ModelRef("string")) // 数据类型
  10.                 .parameterType("header") // 参数类型
  11.                 .defaultValue("default value") // 默认值：可自己设置
  12.                 .hidden(true) // 是否隐藏
  13.                 .required(false) // 是否必须
  14.                 .build());
  16.         // 创建一个 swagger 的 bean 实例
  17.         return new Docket(DocumentationType.SWAGGER_2)
  18.                 .groupName("mike") // 修改组名为 "mike"
  19.                 // 配置接口信息
  20.                 .select() // 设置扫描接口
  21.                 // 配置如何扫描接口
  22.                 .apis(RequestHandlerSelectors
  23.                         .basePackage("com.duojiala.mikeboot.controller") // 扫描指定包下的接口，最为常用
  24.                 )
  25.                 .paths(PathSelectors
  26.                         .any() // 满足条件的路径，该断言总为true
  27.                 )
  28.                 .build()
  30.                 // 添加请求头参数
  31.                 .globalOperationParameters(parameters);
  32.     }

比如接口：

  1. @GetMapping(value = "/get-token")
  2.     @ApiOperation(value = "获取请求头中的token信息")
  3.     public void getToken(
  4.             @RequestHeader(value = "token",required = false) String token
  5.     ) {
  7.         // 直接获取 token 信息
  8.         System.out.println("token = " + token);
  10.         // 通过代码获取
  11.         ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  12.         if (servletRequestAttributes != null) {
  14.             HttpServletRequest request = servletRequestAttributes.getRequest();
  15.             String header = request.getHeader("token");
  16.             System.err.println("header = " + header);
  17.         }
  18.     }

在这里插入图片描述
可以看到这个接口已经可以去设置请求头了，调用接口

在这里插入图片描述
后端也能获取到。

#

发表评论

表情：
评论列表 （有 0 条评论，104人围观）

还没有评论，来说两句吧...

相关阅读