Katalon Studio之swagger中的API导入

 

约束条件:

swagger中一定要在注解@ApiOperation中设置nickname的唯一值,例如:
@ApiOperation(value="新增用户",notes="添加用户",nickname="adduser")
这是因为Katalon在解析swagger的json文件时,API命名是通过提取operationId这个键的值来自动生成的,如果不通过nickname对operationId进行唯一值设置,默认为方法名称+Using+请求方式
,例如:

"post": {
	"tags": [
		"部门管理"
	],
	"summary": "新增单个对象",
	"operationId": "addUsingPOST",
	"consumes": [
		"application/json"
	],
	"produces": [
		"*/*"
	],

当不同类均用add代表添加时,katalon自动生成的API将出现重名问题,不便于接口命名唯一性,因此建议进行约束。

swagger接口文件导出

swagger的正确打开方式其实是api设计器,在接口设计阶段开发人员可以使用swagger Editor编写API设计,评审通过后自动生成项目的api代码框架,开发人员只需要在框架中编写相关接口实现即可,不过现实工作中由于各种原因很多开发工程师在代码编写过程中通过添加注解完成swagger。测试工程师可以通过自己所负责项目的swagger服务自动获取json格式的api文件,方法如下:
访问项目http:IP/swagger-ui.html#/用于获取api-docs路径,如下图所示:

在浏览器中输入:http:IP/api/test/v2/api-docs,显示swagger接口的json内容,如下所示:

将本界面的内容保存为本地的json格式文件(建议使用chrome的FeHelper插件下载json文件)

 启动KS,创建新项目,使用导入swagger的方式创建接口请求,如下图所示:

在弹出的import swagger界面选择刚导出的json文件,点击OK按钮,自动生成接口请求,如下图所示:

双击任意一条请求,右侧显示该请求的相关配置参数,如下图所示:

其中自动生成的请求所有的协议默认为https,如果相关请求不是该协议需要手动修改,例如http(暂未找到解决方式)

转载于:https://www.cnblogs.com/Bug-Hunter/p/10691837.html

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger 本身不支持导入 Excel 来测试 API,但可以通过使用 Swagger 提供的注解和第三方库来实现。 1. Swagger 注解 Swagger 提供了一些注解,可以用来描述 API 信息,包括参数、返回值、请求方法等。其,比较重要的注解包括: - @Api:用来描述 API 的基本信息,包括名称、描述、版本号等。 - @ApiOperation:用来描述 API 的操作信息,包括请求方法、URL、参数、返回值等。 - @ApiParam:用来描述 API 的参数信息,包括参数名称、类型、描述等。 - @ApiResponse:用来描述 API 的返回值信息,包括返回码、消息、数据结构等。 - @ApiModel:用来描述数据模型的信息,包括名称、描述、属性等。 通过使用这些注解,可以使 Swagger 自动生成 API 文档,方便测试和使用。 2. Excel 导入 可以使用第三方库,如 EasyExcel,来读取 Excel 文件,并将数据作为请求参数发送给 API 进行测试。具体步骤如下: - 添加 EasyExcel 依赖:在项目的 pom.xml 文件添加如下依赖: ``` <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2.2.5</version> </dependency> ``` - 编写 Excel 模板:创建一个 Excel 文件,按照 API 的请求参数格式编写数据,并保存为模板文件。 - 读取 Excel 数据:使用 EasyExcel 提供的 API,读取 Excel 数据,并将其转换为请求参数。 - 发送 API 请求:使用 HttpClient 或 RestTemplate 等库,发送 API 请求,并将请求参数作为参数传递给 API。 - 解析 API 响应:解析 API 的响应结果,并将结果写入 Excel 文件。 通过这种方式,可以实现将 Excel 文件作为测试数据,并自动化测试 API 的功能。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值