ajax返回的json统一成什么样的格式比较好？

Question

我在一个项目里看到各种ajax 返回的json格式，比如

{succ:true, msg:"xx"}

{succ:true, data:"xx"}

{ret:"xx"}

{succ:true, result:"xx"}

...

你们是用哪种格式的？

Answer 1

我一般这样干：

{
    "data": {
    },
    "status": {
        "code": 200,
        "message": ""
    }
}

参考：https://bird.ioliu.cn/v1/

Answer 2

{
  "code": 200,
  "data": "xxx",
  "message": "xxx"
}

Answer 3

第二种吧，成功后返回success+data，不成功就返回error+msg
其实是无所谓的，只要确定好一种标准，不要来回变就好了

Answer 4

楼主，你的1,2,4的格式有区别吗？
只是换了个变量名罢了。

Answer 5

124都可以

Answer 6

我用的 success+data+msg, msg 是后端返回前端的消息，这样的话前端可以对提示消息做统一处理，只需要关注data即可。

Answer 7

我一般这样

{errcode: 0, errmsg: '***', data: ***}

一般这样就行了

Answer 8

{code: 200, datas:{"key":"value"}}

Answer 9

{error:0,errmsg:'xxxxxxxxxxxxxx',data:{}} data可以接收一个json对象，例如需要返回一个list

{error:0,errmsg:'xxxxxxxxxxxxxx',
    data:{
        list:[{name:aa,sex:0},{name:bb,sex:0}]
    }
}

Answer 10

{errno:"", msg:"", data:""}

Answer 11

这个明显是根据需要来决定啊。
比如你可以看一下微信的公众号接口返回数据结构，也可以到各种API商店看一下他人接口返回
的数据结构。没有最好的,只有最合适的。

Answer 12

1.合适
2.约定一种就不要来回变

我用flag+data+[msg]

Answer 13

我喜欢这样：
{
    'code' => '200/400/403/403/500/502/503',
    'response' => {
    
    }
}

Answer 14

{
 "info":XXX,
 "code":XXX,
 "url":XXX,
 "data":{
          
        }
}

Answer 15

sign + sign.code这种

Answer 16

没什么好纠结的，但是只能用一种，得有标准，要不调用接口的特别操蛋，一会data，一会result

Answer 17

我觉得你需要这个 RESTful API 设计参考文献列表，可帮助你更加彻底的了解REST风格的接口设计。

同时墙裂推荐其中Github的API设计, 请求成功无需error code及message, 只返回data内容即可, 请求出错再返回相关错误信息:

{
  "message": "Validation Failed",
  "errors": [
    {
      "resource": "Issue",
      "field": "title",
      "code": "missing_field"
    }
  ]
}

这样要简洁得多。

Answer 18

我们目前的规范是：

// 成功
{
    "status": true,   // 必须
    "code": '0000',  // 一般ajax非必须；如果做API接口，必须
    "msg": "成功",  // 非必须
    "data": {  // 非必须
        //...
    }
}

// 失败
{
    "status": false,   // 必须
    "code": '0000',  // 一般ajax非必须；如果做API接口，必须
    "msg": "不合法",  // 必须
    "data": {  // 非必须
        //...
    }
}