最近我们公司开发一个项目, 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:{}}
如果业务不同的错误类型,比如我要提现操作,可能会出现银行卡未绑定、没有上传户口本,没有上传身份证,没有绑定手机号码,没有填写住址等错误,没有余额等等。
こんな種類
http://swagger.io/
http://jsonapi.org/
https://github.com/interagent...
この種の仕様は比較的複雑ですが、一度覚えれば一生使えるもので、フロントエンドもバックエンドも簡単に再利用できます
独自の仕様を定義する利点はシンプルであることですが、設計中に多くの詳細が考慮されていない可能性があるため、修正が非常に面倒になります
https://github.com/ShuyunXIAN...
JSON RPC 2.0
http://www.jsonrpc.org/specif...