跳转到内容

服务测试

API测试与分析 - 配置并分析用户发起的API测试及其结果


启用或禁用服务API的测试

PUT
/api/v1/services/{id}/test/enabled

启用后,该测试将被标记为必做活动,其结果将纳入绩效分析。

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*
类型integer
必填
format"int64"

查询参数

testTypes*

接口测试类型

类型array
必填
uniqueItemstrue
enabled*

启用或禁用

类型boolean
必填

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

创建服务API的测试执行

PUT
/api/v1/services/{id}/exec

如果脚本不存在,则创建脚本

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer
必填
format"int64"

查询参数

testTypes*

测试类型

类型array
必填
uniqueItemstrue

请求体

application/json
JSON
[
]

响应

成功

*/*
JSON
"string"

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

创建服务API的冒烟测试执行

PUT
/api/v1/services/{id}/smoke/exec

如果脚本不存在,则创建脚本

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer
必填
format"int64"

请求体

application/json
JSON
[
]

响应

成功

*/*
JSON
"string"

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

查询服务的所有服务器配置

GET
/api/v1/services/{id}/test/schema/server

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

重新开启服务的现有测试任务

PATCH
/api/v1/services/{id}/test/task/reopen

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

删除服务的测试脚本

DELETE
/api/v1/services/{id}/test/script

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer
必填
format"int64"

查询参数

testTypes*

测试类型

类型array
必填
uniqueItemstrue

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

项目的API测试计数

GET
/api/v1/project/{id}/test/apis/count

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*
类型integer
必填
format"int64"

查询参数

creatorObjectType

查询组织类型,默认为USER

类型string
枚举
"USER""DEPT""GROUP"
creatorObjectId

查询组织ID

类型integer
format"int64"
createdDateStart

资源创建开始日期

类型string
format"date-time"
createdDateEnd

资源创建截止日期

类型string
format"date-time"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

配置并生成服务的测试任务

PUT
/api/v1/services/{id}/test/task/generate

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer
必填
format"int64"

查询参数

taskSprintId

任务迭代ID,敏捷项目管理中必需项

类型integer
format"int64"

请求体

application/json
JSON
[
]

响应

成功

*/*
JSON
"string"

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

重启服务的现有测试任务

PATCH
/api/v1/services/{id}/test/task/restart

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

服务的API测试计数

GET
/api/v1/services/{id}/test/apis/count

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*
类型integer
必填
format"int64"

查询参数

creatorObjectType

查询组织类型,默认为USER

类型string
枚举
"USER""DEPT""GROUP"
creatorObjectId

查询组织ID

类型integer
format"int64"
createdDateStart

资源创建开始日期

类型string
format"date-time"
createdDateEnd

资源创建截止日期

类型string
format"date-time"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

查询服务的测试结果

GET
/api/v1/services/{id}/test/result

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

配置并生成服务的测试脚本

PUT
/api/v1/services/{id}/test/script/generate

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer
必填
format"int64"

请求体

application/json
JSON
[
]

响应

成功

*/*
JSON
"string"

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

删除服务的测试任务

DELETE
/api/v1/services/{id}/test/task

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer
必填
format"int64"

查询参数

testTypes*

测试类型

类型array
必填
uniqueItemstrue

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

创建服务API的冒烟测试执行

PUT
/api/v1/services/{id}/security/exec

如果脚本不存在,则创建脚本

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

服务ID

类型integer
必填
format"int64"

请求体

application/json
JSON
[
]

响应

成功

*/*
JSON
"string"

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

查询项目的测试结果

GET
/api/v1/project/{id}/test/result

授权

UserHttpBearer

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

类型HTTP (bearer)

参数

路径参数

id*

项目ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

基于 GPL-3.0 许可发布