HTTP/HTTPS
请求协议
接口大师 / 后台接口 / 编辑用例
编辑用例
接口地址:https://13520.site/api/admin.php?s=Admin.TestSample.EditTestSample
接口描述: 编辑用例接口
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
id | 整型 | 必须 | - | 要修改的用例id | |
sample_name | 字符串 | 可选 | - | 用例名 | |
api_name | 字符串 | 可选 | - | 接口名称 | |
sample_request | 字符串 | 可选 | - | 请求参数所有的参数传递json字符串,[{"key":"参数","value":"值", "require":"是否必须true/false"}],如果无须请求参数,直接传递[]
示例:[{"key":"app_key","value":"1", "require": "true"}, {"key":"name","value":"yesapi", "require": "false"}] | |
sample_response | 字符串 | 可选 | - | 返回参数所有的参数传递json字符串,[["name":"返回字段","operate":"判断操作", "expect":"预期结果"]],如果无须请求参数,直接传递[]
示例:[{"name":"ret","operate":"=","expect":"200"},{"name":"data.id","operate":">","expect":"123"}], operate操作包括">", "<", "=", "<=", ">=", "!=" | |
sample_host | 字符串 | 可选 | - | 接口域名,默认当前 | |
access_token_config | 字符串 | 可选 | - | 用于测试的access_token |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.isUpdate | bool | 是否更新成功,true表示更新成功,false无更新 |
data.msg | 字符串 | 更新信息 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
id | 必须 | |
sample_name | 可选 | |
api_name | 可选 | |
sample_request | 可选 | |
sample_response | 可选 | |
sample_host | 可选 | |
access_token_config | 可选 |
客户端请求示例
# 暂无示例,可添加示例文件:./src/view/docs/demos/Admin.TestSample.EditTestSample.json
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
500 | 表示服务端内部错误 |
本文档生成时间:2025-01-16 21:47:50