接口用例

接口用例管理 - 用于存储和管理接口用例及断言规则

---

查询API功能测试用例的详细信息

GET

/api/v1/apis/case/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

案件编号

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/apis/case/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

全文搜索API功能测试用例列表

GET

/api/v1/apis/case/search

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

projectId

类型integer

format"int64"

serviceId

类型integer

format"int64"

apisId

类型integer

format"int64"

name

类型string

enabled

测试用例启用标志的默认值为enabled

类型boolean

type

接口用例类型，默认为 USER_DEFINED

类型string

枚举

"SMOKE""SECURITY""BUSINESS""USER_DEFINED"

testMethod

API测试用例方法，默认为NULL

类型string

枚举

"EQUIVALENCE_PARTITIONING""BOUNDARY_VALUE_ANALYSIS""DECISION_TABLE_TESTING""CAUSE_EFFECT_GRAPHING""SCENARIO_TESTING""ERROR_GUESSING""STATE_TRANSITION_TESTING""RANDOM_TESTING""OTHER_TESTING"

protocol

类型string

枚举

"http""https""ws""wss"

method

类型string

枚举

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

endpoint

类型string

createdBy

类型integer

format"int64"

createdDate

类型string

format"date-time"

lastModifiedBy

类型integer

format"int64"

lastModifiedDate

类型string

format"date-time"

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

排序字段

类型string

orderSort

排序方式

类型string

枚举

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

过滤条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

过滤条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

过滤条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

筛选值

类型object

infoScope

查询信息范围

类型string

枚举

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/apis/case/search

试验场

授权

UserHttpBearer

变量

键

值

id

projectId

serviceId

apisId

name

enabled

type

testMethod

protocol

method

endpoint

createdBy

createdDate

lastModifiedBy

lastModifiedDate

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

克隆API功能测试用例

POST

/api/v1/apis/case/clone

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

[

0

]

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/apis/case/clone

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

启用或禁用功能测试用例

PATCH

/api/v1/apis/case/enabled

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

ids*

案件ID

类型array

必填

uniqueItemstrue

enabled*

启用或禁用

类型boolean

必填

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/apis/case/enabled

试验场

授权

UserHttpBearer

变量

键

值

ids*

enabled*

示例

cURL

JavaScript

PHP

Python

---

替换API功能测试用例的名称

PUT

/api/v1/apis/case/{id}/name

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

案件编号

类型integer

必填

format"int64"

查询参数

name*

新案例名称

类型string

必填

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/apis/case/{id}/name

试验场

授权

UserHttpBearer

变量

键

值

id*

name*

示例

cURL

JavaScript

PHP

Python

---

将功能测试用例强制同步到脚本

PATCH

/api/v1/apis/case/syncToScript

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

apisId*

接口ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/apis/case/syncToScript

试验场

授权

UserHttpBearer

变量

键

值

apisId*

示例

cURL

JavaScript

PHP

Python

---

查询API功能测试用例列表

GET

/api/v1/apis/case

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

projectId

类型integer

format"int64"

serviceId

类型integer

format"int64"

apisId

类型integer

format"int64"

name

类型string

enabled

测试用例启用标志的默认值为enabled

类型boolean

type

接口用例类型，默认为 USER_DEFINED

类型string

枚举

"SMOKE""SECURITY""BUSINESS""USER_DEFINED"

testMethod

API测试用例方法，默认为NULL

类型string

枚举

"EQUIVALENCE_PARTITIONING""BOUNDARY_VALUE_ANALYSIS""DECISION_TABLE_TESTING""CAUSE_EFFECT_GRAPHING""SCENARIO_TESTING""ERROR_GUESSING""STATE_TRANSITION_TESTING""RANDOM_TESTING""OTHER_TESTING"

protocol

类型string

枚举

"http""https""ws""wss"

method

类型string

枚举

"GET""HEAD""POST""PUT""PATCH""DELETE""OPTIONS""TRACE"

endpoint

类型string

createdBy

类型integer

format"int64"

createdDate

类型string

format"date-time"

lastModifiedBy

类型integer

format"int64"

lastModifiedDate

类型string

format"date-time"

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

排序字段

类型string

orderSort

排序方式

类型string

枚举

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

过滤条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

过滤条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

过滤条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

筛选值

类型object

infoScope

查询信息范围

类型string

枚举

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/apis/case

试验场

授权

UserHttpBearer

变量

键

值

id

projectId

serviceId

apisId

name

enabled

type

testMethod

protocol

method

endpoint

createdBy

createdDate

lastModifiedBy

lastModifiedDate

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

替换API功能测试用例

PUT

/api/v1/apis/case

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/apis/case

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

添加API功能测试用例

POST

/api/v1/apis/case

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/apis/case

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

删除API功能测试用例

DELETE

/api/v1/apis/case

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

[

0

]

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/apis/case

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

更新API功能测试用例

PATCH

/api/v1/apis/case

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/apis/case

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---