文档首页> 测试计划 CodeArts TestPlan> 用户指南> TestHub> TestHub测试工具集成接口规范

更新时间：2023-01-04 GMT+08:00

查看PDF

TestHub测试工具集成接口规范

TestHub采用华为云IAM认证鉴权与注册的测试工具的接口进行交互。

TestHub在调用新测试类型服务接口时，使用用户登录软件开发生产线后的IAM Token信息。

如果是通过APIG方式进行接口调用，测试工具需将自己的接口发布到华为云APIG上并对测试计划服务授权。

创建用例

接口描述
- 功能介绍：TestHub调用测试工具此接口创建测试用例
- 请求方式：POST
- 请求URL：
  {服务域名}/v1/testcase
- 请求头：
```
"Content-Type": "application/json; charset=UTF-8",
"Accept-Language": "zh-cn"
```

请求参数

字段	含义	类型	长度	是否必填
name	用例名称	String	大于3小于128	是
project_uuid	软件开发生产线项目的唯一标识	String	32	是
case_id	用例唯一标识	String	32	是

请求消息样例：

{
	"name": "test01",
	"project_uuid": "ec22e1930cc04e6c9e68cb978bc33e74",
	"case_id": "ec22e1930cc04e6c9e68cb978bc33e74"
}

响应参数

字段	含义	类型	长度	是否必填	备注
status	返回操作的提示信息	String	不限	是	调用成功返回success，调用失败返回error
result	操作成功返回的信息	Object	不限	否	参数详细说明可参考•操作成功返回信息
error	异常响应	Object	不限	否	参数详细说明可参考•异常响应

响应消息样例：

{
	"status": "success",
	"result": {
	}
}

更新用例

接口描述
- 功能介绍：TestHub调用测试工具此接口更新测试用例名称
- 请求方式：PUT
- 请求URL：
  {服务域名}/v1/testcase
- 请求头：
```
"Content-Type": "application/json; charset=UTF-8",
"Accept-Language": "zh-cn"
```

请求参数

字段	含义	类型	长度	是否必填
name	用例名称	String	大于3小于128	是
project_uuid	软件开发生产线项目的唯一标识	String	32	是
case_id	用例唯一标识	String	32	是

请求消息样例：

{
	"name": "test02",
	"project_uuid": "ec22e1930cc04e6c9e68cb978bc33e74",
	"case_id": "ec22e1930cc04e6c9e68cb978bc33e74"
}

响应参数

字段	含义	类型	长度	是否必填	备注
status	返回操作的提示信息	String	不限	是	调用成功返回success，调用失败返回error
result	操作成功返回的信息	Object	不限	否	参数详细说明可参考•操作成功返回信息
error	异常响应	Object	不限	否	参数详细说明可参考•异常响应

响应消息样例：

{
	"status": "success",
	"result": {
	}
}

删除用例

接口描述

功能介绍：TestHub调用测试工具此接口删除测试用例
请求方式：DELETE
请求URL：
{服务域名}/v1/testcase? project_uuid={projectUUId}&case_id={caseId}

参数说明

字段	含义
project_uuid	软件开发生产线项目的唯一标识
case_id	用例唯一标识

请求头：

"Content-Type": "application/json; charset=UTF-8",
"Accept-Language": "zh-cn"

响应参数

字段	含义	类型	长度	是否必填	备注
status	返回操作的提示信息	String	不限	是	调用成功返回success，调用失败返回error
result	操作成功返回的信息	Object	不限	否	参数详细说明可参考•操作成功返回信息
error	异常响应	Object	不限	否	参数详细说明可参考•异常响应

响应消息样例：

{
	"status": "success",
	"result": {
	}
}

执行用例

接口描述
- 功能介绍：TestHub调用测试工具此接口执行测试用例
- 请求方式：POST
- 请求URL：
  {服务域名}/v1/testcase/execute
- 请求头：
```
"Content-Type": "application/json; charset=UTF-8",
"Accept-Language": "zh-cn"
```

请求参数

字段	含义	类型	长度	是否必填
project_uuid	软件开发生产线项目的唯一标识	String	32	是
case_id	用例唯一标识	String	32	是

请求消息样例

{
	"project_uuid": "ec22e1930cc04e6c9e68cb978bc33e74",
	"case_id": "ec22e1930cc04e6c9e68cb978bc33e74"
}

响应参数

字段	含义	类型	长度	是否必填	备注
status	返回操作的提示信息	String	不限	是	调用成功返回success，调用失败返回error
result	操作成功返回的信息	Object	不限	否	参数详细说明可参考•操作成功返回信息
error	异常响应	Object	不限	否	参数详细说明可参考•异常响应

响应消息样例：

{
	"status": "success",
	"result": {
		"execute_id": "ec22e1930cc04e6c9e68cb978bc33e74"
	}
}

停止用例

接口描述
- 功能介绍：TestHub调用测试工具此接口停止执行测试用例
- 请求方式：POST
- 请求URL：
  {服务域名}/v1/testcase/stop
- 请求头：
```
"Content-Type": "application/json; charset=UTF-8",
"Accept-Language": "zh-cn"
```

请求参数

字段	含义	类型	长度	是否必填
project_uuid	软件开发生产线项目的唯一标识	String	32	是
case_id	用例唯一标识	String	32	是
execute_id	测试工具的执行id	String	小于等于32	是

请求消息样例：

{
	"project_uuid": "ec22e1930cc04e6c9e68cb978bc33e74",
	"case_id": "ec22e1930cc04e6c9e68cb978bc33e74",
	"execute_id": "ec22e1930cc04e6c9e68cb978bc33e74"
}

响应参数

字段	含义	类型	长度	是否必填	备注
status	返回操作的提示信息	String	不限	是	调用成功返回success，调用失败返回error
result	操作成功返回的信息	Object	不限	否	参数详细说明可参考•操作成功返回信息
error	异常响应	Object	不限	否	参数详细说明可参考•异常响应

响应消息样例

{
	"status": "success",
	"result": {
	}
}

获取用例状态

接口描述
- 功能介绍：TestHub调用测试工具此接口获取测试用例某次执行状态
- 请求方式：POST
- 请求URL：
  {服务域名}/v1/testcase/query/status
- 请求头：
```
"Content-Type": "application/json; charset=UTF-8",
"Accept-Language": "zh-cn"
```

请求参数

字段	含义	类型	长度	是否必填
project_uuid	软件开发生产线项目的唯一标识	String	32	是
query_list	获取用例状态的用例信息	List	小于等于50	是

其中，参数“query_list”说明如下：

字段	含义	类型	长度	是否必填
case_id	用例唯一标识	String	32	是
execute_id	标识用例某一次执行的id	String	小于等于32	是

请求消息样例

{
	"project_uuid": "ec22e1930cc04e6c9e68cb978bc33e74",
	"query_list": [{
		"case_id": "ec22e1930cc04e6c9e68cb978bc33e74",
                "execute_id": "ec22e1930cc04e6c9e68cb978bc33e74"
	},
	{
		"case_id": "ec22e1930cc04e6c9e68cb978bc33e74",
                "execute_id": "ec22e1930cc04e6c9e68cb978bc33e74"
	}]
}

响应参数

字段	含义	类型	长度	是否必填	备注
status	返回操作的提示信息	String	不限	是	调用成功返回success，调用失败返回error
result	操作成功返回的信息	Object	不限	否	参数详细说明可参考•操作成功返回信息
error	异常响应	Object	不限	否	参数详细说明可参考•异常响应

响应消息样例：

{
	"status": "success",
	"result": {
		"status_list": [{
			"case_id": "ec22e1930cc04e6c9e68cb978bc33e"，
			"execute_id": "ec22e1930cc04e6c9e68cb978bc33",
			"result": "5",
			"start_time": 214214235,
			"end_time": 1213421434,
			"duration": 1231232
		},
		{
			"case_id": "ec22e1930cc04e6c9e68cb978bc33e",
			"execute_id": "ec22e1930cc04e6c9e68cb978bc33",
			"result": "5",
			"start_time": 214214235,
			"end_time": 1213421434,
			"duration": 1231232
		}]
	}
}

响应说明

操作成功返回信息

操作成功返回的信息“result”中，可选返回参数如下：

字段	含义	类型	长度	备注
status_list	用例结果列表	List	小于等于50	只在查询用例状态时使用
start_time	用例开始执行时间	long	不限	时间戳
end_time	用例结束执行时间	long	不限	时间戳
duration	持续时间	long	不限	持续执行时长（单位：ms）
result	执行结果	String	1	-1-未执行 0-成功 1-失败 2-待核查 3-不可用 4-阻塞 5-执行中 6-停止
execute_id	测试工具的用例执行记录id，唯一	String	小于等于32	-
project_id	测试工具的项目id	String	小于等于32	-
id	测试工具的用例唯一标识	String	小于等于32	-

异常响应

异常响应消息样例：

{
	"status": "failed",
	"error": {
		"code": "错误编码",
		"message": "导致错误的原因说明"
	}
}

其中，code与message请自定义。

父主题： TestHub

上一篇：导读

下一篇：TestHub测试工具集成页面规范

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

TestHub测试工具集成接口规范

创建用例

更新用例

删除用例

执行用例

停止用例

获取用例状态

响应说明

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线