您的位置:首页 > 其它

前后端接口规范-------通用响应格式3

2016-12-10 10:06 483 查看
参数无效

状态码:409

响应格式:

{
"fields": [
{
"field": {string}, // 字段名称
"message": {string} // 错误原因
},
...
],
"message": {string}, // 不属于任何字段的错误,如实体当前状态不允许操作,可选
"errorId": {number} // 如果有全局的错误,可选择性提供errorId便于后续问题排查,可选
}

关于字段名称

在409的响应中,fields数组中的每一项都会有field字段标识出错的字段名称。

field字段的值必须与请求的字段名称对应,不应该超出请求所提供的字段范围。

对于请求中的复杂字段名,如使用JSON作为数据格式请求时的嵌套对象的字段、数组中对象的字段,应当使用点号.进行分隔来表示一个字段的访问路径,如:

{
"field": "deliveries.2.amount", // 表示deliveries数组字段的第2项的amount字段
"message": "售卖量不能为负数"
}

登录超时 / 未登录

状态码:403

响应内容:空
服务器内部错误

状态码:500

响应格式

{
"message": {string}, // 友好的错误信息,可选,如不提供前端应当使用默认的提示信息
"errorId": {number} // 返回一个可用于后续问题排查的错误id号,如当次异常的日志id
}
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: 
相关文章推荐