服务器的 json api 的 response 一定要有 code, msg, data 这些字段吗

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

这是一个创建于 2926 天前的主题，其中的信息可能已经有所发展或是发生改变。

看了"还能不能好好的写 API 了"( https://www.v2ex.com/t/321243) 这个帖子, 准备所有接口都按状态码 200 和 { code: Number, msg: String, data: Object } 这样的结构返回, 但是假如只返回一个有意义的字段的话(比如只是返回一个 id ), 感觉没必要用 data 字段套一层, 如果 code 是 0, msg 字段也可以不要了.

我看微信公众号开发文档里面, code, msg, data 这些字段都是有的, 就算不返回任何有意义的信息, 这三个字段都有.

有没有人可以说说这么做的优劣?

字段

msg

API

Code

13 条回复 • 2020-05-04 18:26:54 +08:00

Totato5749

2016-11-18 11:16:01 +08:00

后端是 java 写的话，序列化一个 bean 对象一般就不去修剪了吧我猜是这样的

justfindu

2016-11-18 11:18:09 +08:00

那其他人用你接口时候还得注意, 这个接口有没有 msg 有没有 data , 你自己写的时候还要区分 data 要不要 msg 要不要?
不嫌麻烦?

beneo

2016-11-18 11:22:30 +08:00

简单来说， http response code 不能完全的满足业务需求，也就是业务上的 error code 不能完全的映射到 http response code 上面，所以索性，全部返回 200 ，靠里面的 error code 来区分

Jakesoft

2016-11-18 11:45:32 +08:00

我是有的，{"code":0,"status":1,"data":[{object},{object},{object}],"message":"ok"}，

或者 {"code":2333,"status":0,"data":[],"message":"fail"}，

这样统一设计挺好的，可以通用，

并且 status 不使用字符串，比如"success"/"fail",也不使用 boolean ，

SoloCompany

2016-11-18 12:07:54 +08:00

10+年前定的协议
{“ code ”:” 233 ”,” var ”:{…}}
到现在都没有改过
为了适应业务的复杂性， code 是 string 类型而不是 int

当然 10+年前的 json 还没这么流行，所以其实是
<object><string name=“ code ”>233</string><object name=“ var ”>...</object></object>