设计 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:{}}
如果业务不同的错误类型,比如我要提现操作,可能会出现银行卡未绑定、没有上传户口本,没有上传身份证,没有绑定手机号码,没有填写住址等错误,没有余额等等。
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(4)
这种
http://swagger.io/
https://github.com/ShuyunXIAN...
JSON RPC 2.0
http://www.jsonrpc.org/specif...
楼主最后用的哪一种?