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

参数无效

状态码: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
}

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值