3.Swagger 项目中的用法

置顶 Arik~朽木

已于 2022-07-16 14:42:34 修改

阅读量710

点赞数 1

分类专栏：接口调试文章标签： postman java 测试工具

于 2022-07-03 17:20:11 首次发布

本文链接：https://blog.csdn.net/weixin_43159673/article/details/125586461

版权

接口调试专栏收录该内容

2 篇文章 0 订阅

订阅专栏

一、Swagger简介

1.1 前后端分离

Vue + SpringBoot

后端时代：前端只用管理静态页面；html==>后端，模板引擎 jsp==> 后端主力

前后端分离时代

后端：后端控制层、服务层、数据访问层【后端团队】

前端：前端控制层、视图层【前端团队】

伪造后端数据，json,已经存在xxx.js 不需要后端，前端工程依旧可以运行。

*前后端如何交互？===》API*

前后端相对独立，解耦合;

前后端可以部署在不同的机器上面;

产生的问题：

前后端联调，前端人员和后端人员无法做到，即使协商，今早解决，最终导致问题集中爆发

【解决方案】

首先schema【计划的提纲，实时更新最新API,降低集成的风险】
早些年：指定word计划文档;
前后端分离：

前端测试后端接口：postman 测试请求接口;

后端提供接口，需要实时更新最新的接口及改动！Swagger

二、Swagger API 文档

2.1 RestFull API 文档在线自动生成;

2.2 直接运行，可以在线测试API

2.3 支持多种语言

2.4 官网地址：

https://swagger.io/
Swagger2-ui
在这里插入图片描述

2.5 Springboot集成Swagger

2.5.1 新建一个spring boot项目

2.5.2 导入相关依赖

<!--swagger config start-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.8.0</version>
    </dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.8.0</version>
</dependency>

3.5.2 编写代码工程

2.5.3 SwaggerConfig配置

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

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

2.5.4 访问测试

http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；
在这里插入图片描述

2.5.5 配置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()

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

2.5.6 配置扫描接口

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

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.arik.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、除此之外，我们还可以配置接口扫描过滤：

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.arik.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/arik开头的接口
      .paths(PathSelectors.ant("/arik/**"))
      .build();
}

5、这里的可选值还有

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

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

@Bean
public Docket docket() {
  return new Docket(DocumentationType.SWAGGER_2)
   .apiInfo(apiInfo())
   .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
   .apis(RequestHandlerSelectors.basePackage("com.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、除此之外，我们还可以配置接口扫描过滤：

@Bean
public Docket docket() {
  return new Docket(DocumentationType.SWAGGER_2)
   .apiInfo(apiInfo())
   .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
   .apis(RequestHandlerSelectors.basePackage("com.arik.swagger.controller"))
    // 配置如何通过path过滤,即这里只扫描请求以/arik开头的接口
   .paths(PathSelectors.ant("/arik/**"))
   .build();
}

5、这里的可选值还有

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

3.5.7 配置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.arik.swagger.controller"))
    // 配置如何通过path过滤,即这里只扫描请求以/arik开头的接口
   .paths(PathSelectors.ant("/arik/**"))
   .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.arik.swagger.controller"))
    // 配置如何通过path过滤,即这里只扫描请求以/arik开头的接口
   .paths(PathSelectors.ant("/arik/**"))
   .build();
}

3、可以在项目中增加一个dev的配置文件查看效果！
在这里插入图片描述
2.5.7 配置API分组

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

2.5.8 实体配置

1、新建一个实体类

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

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

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

3、重启查看测试
在这里插入图片描述

2.5.9 常用配置

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

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

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

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

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

}

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

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

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

2.6 拓展配置

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

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、Layui-ui 访问 http://localhost:8080/docs.html

<!-- 引入swagger-ui-layer包 /docs.html-->
<dependency>
  <groupId>com.github.caspar-chen</groupId>
  <artifactId>swagger-ui-layer</artifactId>s
  <version>1.1.3</version>
</dependency>

在这里插入图片描述
4、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>