设计 API 接口返回的 JSON 数据格式有没有比较流行的最佳实践？

Question

最近我们公司开发一个项目， PC 端 手机 APP 端 手机网页端 设计 API 接口返回的 JSON 数据格式有没有比较流行的最佳实践？

目前找了以下几种版本

版本 1 ： 成功执行： head Status Code:2XX

json {"id":51,"age":58,"name":"lifei"}

失败执行 head Status Code:4XX-5XX {"message":"xxxxxx 错误","errors:{}}

版本 2 ： 成功和失败执行 head Status Code:2xx

json {"code":"0","message:"信息","data":{}}

版本 3: 成功执行： head Status Code:2XX

json {"id":51,"age":58,"name":"lifei"}

失败执行 head Status Code:4XX-5XX {"code":10001, "message":"xxxxxx 错误","errors:{}}

Answer 1

约定妥了以后就可以压缩点关键字，一个字符表示状态

Answer 2

rest风格是看起来不错，但是业务上的东西，跟http状态混到一块儿就有点怪了。

而且前端要有好多东西来判断：

创建个东西 201状态，空内容。

找不到东西 404  空内容。。

找到东西 是对象的 json

内部错误 500 丢一个另外一个结构的json。。。

还不如一套结构下来，用一个字段标识状态，统一一点

Answer 3

rest风格的话用版本1。实际上我觉得rest并不好，用版本2吧，不把http错误跟业务错误混在一起。

Answer 4

410 401 400 422 416

Answer 5

还是采用第一个方案吧，比如404 一看就知道资源未找到。

Answer 6

那为什么回答了？

Answer 7

随便看看都不想回答了。

Answer 8

JSON

Answer 9

webservice返回的是JSON还是XML?

Answer 10

楼上几个都用版本2呢

Answer 11

@eechen的粉丝 确实国内很多所谓的rest api都不是真正的api，很多都没把我住rest的真正含义。

Answer 12

如果业务不同的错误类型，比如我要提现操作，可能会出现银行卡未绑定、没有上传户口本，没有上传身份证，没有绑定手机号码，没有填写住址等错误，没有余额等等用什么状态码

Answer 13

不建议版本2，REST API中有一条就是用已知的HTTP请求错误码来区分错误，比如客户端请求一个不存在的对象，就用404表示错误。个人推荐第一种。

Answer 14

版本2 比较不错 公司也在使用

Answer 15

引用来自“卖萌的程序猿”的评论

个人推荐版本2，程序级别的错误就应该程序级别来处理和对接，head code的错误用于系统级别，比如404、500等

Answer 16

个人推荐版本2，程序级别的错误就应该程序级别来处理和对接，head code的错误用于系统级别，比如404、500等