果果云 / 后台接口 / 添加用例

添加用例

接口描述: 添加用例接口

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
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字符串可选http://open.phalapi.net/api/app.php接口路径,默认当前
access_token_config整型必须-用于测试的access_token的全局配置的id

参数名字

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.codebool成功是否成功
data.msg字符串添加信息
data.id整型用例id
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
sample_name 必须
api_name 必须
sample_request 必须
sample_response 必须
sample_host 可选
access_token_config 必须

客户端请求示例

# 暂无示例,可添加示例文件:./src/view/docs/demos/Admin.TestSample.AddTestSample.json

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
500表示服务端内部错误

本文档生成时间:2020-07-02 21:07:37