HTTP/HTTPS
请求协议
APIUSB / 后台接口 / 获取用例,及用例的测试快照
获取用例,及用例的测试快照
接口地址：https://api.apiusb.com/api/admin?s=Admin.TestSample.GetTestSample
接口描述： 获取用例接口
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| access_token | 字符串 | 可选 | 访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口 | ||
| id | 整型 | 必须 | - | 用例id |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| data.id | 整型 | 用例id |
| data.uid | 字符串 | 添加用例人 |
| data.api_name | 字符串 | 用例接口名 |
| data.sample_name | 字符串 | 用例名称 |
| data.sample_request | 字符串 | 用例请求参数 |
| data.sample_response | 字符串 | 用例期待返回 |
| data.sample_host | 字符串 | 用例接口域名 |
| data.sample_status | 整型 | 用例测试结果(0为测试,1测试通过,2测试失败) |
| data.access_token | 字符串 | 用例使用的access_token配置的id |
| data.access_token_name | 字符串 | 用例配置名 |
| data.add_time | 字符串 | 添加时间 |
| data.last_time | 字符串 | 最后测试时间 |
| data.log | 字符串 | 测试快照 |
| data.test_time | 字符串 | 测试时间 |
| data.test_status | 字符串 | 用例测试结果(0为测试,1测试通过,2测试失败) |
| data.test_result | 字符串 | 测试返回结果 |
| data.test_detail | 字符串 | 失败原因 |
| data.percent | 字符串 | 测试通过率 |
| data.last_test_res | 字符串 | 最新测试结果 |
| data.success | 整型 | 成功数 |
| data.fail | 整型 | 失败数 |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 可选 | |
| id | 必须 |
客户端请求示例
# 暂无示例，可添加示例文件：./src/view/docs/demos/Admin.TestSample.GetTestSample.json错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400，客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406，access_token令牌校验不通过 |
| 407 | ret=407，app_key权限不足，或未知应用 |
| 408 | ret=408，当前用户禁止使用，或用户未登录 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2024-04-20 02:05:10