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（暂未找到解决方式）