有个疑问, api 接口返回的 json 格式数据, key 是用驼峰写法还是下划线写法?

2020-08-13 11:27:20 +08:00
 immango

如题,对接一些接口,返回值有两种样式 驼峰写法: { "firstKey": "value" } 有些是下划线: { "first_key": "value" }

想问一下大家,这玩意有规范吗。大家在平常的工作用那种多些。 个人觉得驼峰比较适合和 java 的后端对接-.-。不知道支付宝的下划线是有什么说法没有,大佬们说说。

支付宝的相关文档是用下划线的(官方文档示例):

{

"ant_merchant_expand_item_open_create_response": {
    "code": "10000",
    "msg": "Success",
    "item_id": "2018091300502200002600104169"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"

}

3021 次点击
所在节点    问与答
8 条回复
dsphper
2020-08-13 11:48:41 +08:00
这问题和花括号换行和不换行一样,我认为 json 下划线优于驼峰,不为啥就是觉得下划线好看。
Vegetable
2020-08-13 11:51:20 +08:00
我对这个东西的底线要求是,自己内部统一,一套接口统一风格。选择哪一套无所谓。
哦对,还有不要要拼音首字母,哪怕是中文都行
immango
2020-08-13 12:02:19 +08:00
@dsphper 那 Java 后端接受的时候,是不是加上 @JsonProperty 转成驼峰
KalaSearch
2020-08-13 12:20:07 +08:00
我们统一用的驼峰: https://kalasearch.cn/docs/rest-api-index-and-search

Stripe 用的是下划线: https://stripe.com/docs/api/pagination

微软用的是驼峰

没有统一标准,参考: https://stackoverflow.com/questions/5543490/json-naming-convention
shoaly
2020-08-13 12:20:14 +08:00
取决于 是你求着接 API, 还是 API 求着你来接
oneisall8955
2020-08-13 13:15:09 +08:00
对于 JAVA 来说,可以使用 @JsonNaming 的注解配置成 snake 形式。规范就行了,哪种都可以表情
loshine1992
2020-08-13 13:44:10 +08:00
Java 的 IDE 有插件可以自动把下划线转驼峰生成对应的类

反正标准统一就行。
a3613051
2020-08-13 15:32:47 +08:00
内部统一即可。 最近和京东某业务对接。俩套接口 一套下划线一套小驼峰,共用的鉴权还是小驼峰。接口文档写的不想吐槽,联调过程极其难受。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/697907

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX