果果云 / 后台接口 / 更新接口设计

更新接口设计

接口描述: 更新接口设计

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
id整型必须-要更新的id
api_name字符串可选-最大:100接口服务名称,必须以App开头
api_modules字符串可选-接口模块名称
api_title字符串可选-接口服务名称
api_desc字符串可选-接口服务描述
api_request_params字符串可选-接口请求参数所有的参数传递json字符串,
请求的参数key分别对应:name:参数名称(英文), type:类型, desc:参数说明, require:必须(true或者false), default:默认值, max:最大值, min:最小值。当为空时填null。
示例: [{"name":"yesapi","type":"string","require":true,"default":"phalapi","min":1,"max":100,"desc":"描述"},{"name":"age","type":"int","require":false,"default":"1","min":0,"max":100,"desc":"年龄"}]
更多详细规则参考:接口参数规则
api_response_params字符串可选-接口返回参数所有的参数传递json字符串,请求的参数key分别对应:
name:返回字段名称(英文), type:返回字段类型, desc:返回字段说明。 type的值可能为string,int,float,bool,array,object,date 示例: [{"name":"yesapi","type":"string","desc":"描述"},{"name":"age","type":"int","desc":"年龄"}]
api_response_example字符串可选-接口返回示例(json)

参数名字

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

在线测试   

参数是否必须
service 必须
access_token 可选
id 必须
api_name 可选
api_modules 可选
api_title 可选
api_desc 可选
api_request_params 可选
api_response_params 可选
api_response_example 可选

客户端请求示例

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

错误列表

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

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