swagger是什么?
Swagger是一组围绕 OpenAPI 规范构建的开源工具,可以用于设计、构建、记录和使用 REST API。
swagger能做什么?
swagger可以帮助我们调试后端web接口,并且可以便捷地生成接口文档。
这里介绍一下好用的工具——“knife4j”,它是一个集Swagger2及OpenAPI3为一体的增强解决方案. | Knife4j (xiaominfo.com)
这边我们使用knife4j来做相关演示。
如何进行接口测试
准备工作,引入依赖
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
<version>4.0.0</version>
</dependency>
配置knife4j
使用knife4j前,需要进行实现的配置。
这里以SpringBoot中最常用的yml配置文件为例:
knife4j:
enable: true
openapi:
title: knife4j项目的名称
description: knife4j项目的描述
email: 项目邮箱
concat: 贡献者名称
url: 项目的地址
license: Apache 2.0
license-url: http://www.apache.org/licenses/LICENSE-2.0
terms-of-service-url: XXXXXX
enable项是必须配置的,其它测试阶段可以省略。
常用的注解
序列 | 注解 | 作用 |
---|---|---|
1 | @Api(tags = “01.模块名称”) | 添加在控制器类上,通过tags属性可配置模块名称(可在每个模块名称之前添加数字,则API文档会根据名称前面的数字升序排列) |
2 | @ApiOperation(value=“接口说明”,notes=“接口备注描述”) | 添加在处理请求的方法上,通过value属性可配置接口说明 |
3 | @ApiImplicitParam(name = “参数名”, value = “参数说明”, required = true) | 通过name属性表示配置方法的哪个请求参数,通过value属性配置请求 |