搜索

首页  >  问答  >  正文

angular.js - 设计 API 接口返回的 JSON 数据格式有没有比较流行的最佳实践?

最近我们公司开发一个项目, 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:{}}

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

phpcn_u1582phpcn_u15822782 天前624

全部回复(4)我来回复

  • phpcn_u1582

    phpcn_u15822017-05-15 17:07:02

    这种
    http://swagger.io/

    回复
    0
  • 巴扎黑

    巴扎黑2017-05-15 17:07:02

    http://jsonapi.org/

    https://github.com/interagent...

    这种规范都比较复杂,但是学一次终身受用,而且前端和后端都可以很方便复用

    自己定义规范优势就是简单,但是很多细节问题可能设计的时候考虑不到,修改起来很麻烦

    回复
    0
  • 巴扎黑

    巴扎黑2017-05-15 17:07:02

    https://github.com/ShuyunXIAN...

    回复
    0
  • 为情所困

    为情所困2017-05-15 17:07:02

    JSON RPC 2.0
    http://www.jsonrpc.org/specif...

    回复
    0
  • 取消回复