美文网首页
接口响应内容的格式

接口响应内容的格式

作者: 葬花逐流 | 来源:发表于2019-05-17 11:26 被阅读0次

服务端成功处理API请求的时候,响应的关键内容有:

{
    "status":"OK" //或者 status:1
    "msg":"查询成功,由于数据量太大,只输出10条。"
    "data":[{...},{...},{...},{...},{...},{...},{...},{...},{...},{...}]
}

处理API请求异常的时候,响应的关键内容有:

{
    "status":"error", //或者 status:0
    "bizcode":"GYB62125",
    "msg":"查询条件--企业统一社会信用代码不能为空"
    "error":"com.xyz.exception.BizException"
}

所以,将正常响应内容和异常响应内容统一格式后的模板为:

{
    "status":"ok|error", //或者 status:1|0
    "code":"[a-z,A-Z,0-9]+",
    "msg":"..."
    "data":{object}
}

相关文章

网友评论

      本文标题:接口响应内容的格式

      本文链接:https://www.haomeiwen.com/subject/llynaqtx.html