文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 接口测试套管理/ 通过导入仓库中的文件生成接口测试套
更新时间:2023-06-26 GMT+08:00

通过导入仓库中的文件生成接口测试套

功能介绍

通过导入仓库中的文件生成接口测试套

URI

POST /v1/projects/{project_id}/repository/testsuites

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:100000

表3 请求Body参数

参数

是否必选

参数类型

描述

testsuite_name

String

要生成的测试套名称

最小长度:3

最大长度:128

repository_id

String

仓库id

最小长度:32

最大长度:32

repository_branch

String

仓库分支

最小长度:3

最大长度:100

file_path

String

仓库中yaml或json文件的相对路径,仅支持swagger 2.0版本的yaml和json文件

最小长度:6

最大长度:128

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

testsuite_id

String

生成的测试套的id

最小长度:32

最大长度:32

testcase_ids

Array of strings

生成的测试用例id列表

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

最小长度:16

最大长度:16

error_detail

Array of CommonResponseDetail objects

接口调用失败的详情信息,非参数校验失败没有该结构

error_msg

String

接口调用失败错误信息

最小长度:3

最大长度:100

表6 CommonResponseDetail

参数

参数类型

描述

step_name

String

记录错误步骤名称

最小长度:3

最大长度:100

testcase_name

String

用例名称

最小长度:3

最大长度:128

fail_content

String

记录实际错误内容值

最小长度:3

最大长度:128

fail_keys

String

记录包含错误的关键字

最小长度:3

最大长度:128

fail_source

String

记录错误部位header name等

最小长度:3

最大长度:100

fail_type

String

记录错误类型

最小长度:3

最大长度:100

stage

String

记录包含错误阶段

最小长度:2

最大长度:50

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

{
  "testsuite_name" : "jalor_test_suite",
  "repository_id" : "aa03aeee96fa48f0acc223f0ab503a1f",
  "repository_branch" : "master",
  "file_path" : "apitest.yaml"
}

响应示例

状态码: 201

Created

{
  "testsuite_id" : "",
  "testsuite_ids" : [ "" ]
}

状态码

状态码

描述

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码