接口测试工具swagger2(knife4j)

swagger是什么？

Swagger是一组围绕 OpenAPI 规范构建的开源工具，可帮助您设计、构建、记录和使用 REST API。主要的 Swagger 工具包括：Swagger Editor – 基于浏览器的编辑器，您可以在其中编写 OpenAPI 规范。Swagger UI – 将 OpenAPI 规范呈现为交互式 API 文档。swagger2于17年停止维护，现在最新的版本为 Swagger3（Open Api3）。

knife4j与springboot的兼容性

一、导入依赖

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
    <version>4.0.0</version>
</dependency>

二、配置

knife4j:
  enable: true                 #此项必配置，否则knife4j运行有问题

  openapi:
    title: knife4j项目的名称
    description: knife4j项目的描述
    email: 项目邮箱
    concat: 贡献者名称
    url: 项目的地址
    license: Apache 2.0
    license-url: 
    terms-of-service-url: 

tips: 配置除enable,其它测试阶段可以省略。

三、常用注解

在返回对象上使用

在HttpResp(用户封装返回对象的类)

序列	注解	作用
1	@ApiModel	用对象来接收参数
2	@ApiModelProperty	用对象接收参数时，描述对象的一个字段

在Controller类和方法上使用

序列	注解	作用
1	@Api(tags = “Knife4jController接口类”)
2	@Api	修饰整个类，描述api(Controller)的作用
3	@ApiOperation	描述一个类的一个方法，或者说一个接口
4	@ApiImplicitParam	多个请求参数的描述信息
5	@ApiImplicitParam（name = “name”,value=”请求的名称”,required = true）	单个参数的描述信息
6	@ApiIgnore	使用该注解忽略这个API
7	@ApiError	发生错误返回的信息

@ApiImplicitParm的属性

序列	属性	值	作用
1	paramType		查询参数类型
		path	以地址形式提交数据
		query	直接跟参数完成映射赋值
		body	以流的形式提交 仅支持POST
		header	参数在request headers里面提交
		form	以form表单的形式提交，仅支持POST
2	dataType		参数的数据类型 只为标志说明 并没有实际验证
		Long
		String
3	name		接收参数名
4	value		接收参数的意义描述
5	required		参数是否必填
		true	必填
		false	非比填
6	defaultValue		默认值

四、项目案例

HttpResp

@Data
@NoArgsConstructor
@AllArgsConstructor
public class HttpResp<T> {
    private int code;
    private String msg;
    private T result;
    private LocalDate time;
}

Controller

无参数

方法有参数

带上传参数

五、测试

主页

Model

API测试

产生离线文档