日常和开发约定 JSON 接口,每次项目都按开发个人喜好给,各种字段定义和命名规范,没法满足我强烈的代码洁癖症。今天看到个东东,有没有类似的推荐?
传送门: http://labs.omniti.com/labs/jsend
传送门: http://labs.omniti.com/labs/jsend
1
eslizn Jul 29, 2014 我一般就是标准http请求报文,返回的json :{status:number, msg:string, data:{...}}
|
2
Livid MOD PRO 以前我在设计 JSON 接口的时候,当时是参考看 Twitter 的 API 接口是怎么设计的。
|
3
datou552211 Jul 29, 2014 https://github.com/interagent/http-api-design
之前收藏的,看过感觉挺有帮助的。希望对你有用 |
4
tamamaxox Jul 29, 2014 |
5
julyclyde Jul 30, 2014
见过不少把status写在json内,而不用HTTP status line的
感觉很寨 但既然很多这么用的,自然有理由。求教到底是什么理由 |
11
siteshen Aug 8, 2014
@julyclyde 理由之一是方便客户端处理,客户端可以无脑解析body(某些客户端http请求返回非2xx状态码时异常),统一处理。现在我们的方式是,status line里有写,json body里也有写(相同),客户端爱咋搞咋搞。
@tinyhill 我司的JSON接口字段定义绝大部分按DB定义中的来,尽量保持API和DB的一致(好了,现在引入了另外一个问题“有比较流行的数据库字段命名规范么”)。 另 1.我司的API在JSend基础上增加了meta字段,添加额外信息(next_url, elapsed_ms)等; 随口吐个槽,这个怎么会放在JavaScript这个节点下面?不应该是API设计之类的节点吗? |
12
justjavac Oct 12, 2014 @tamamaxox 我正在翻译中文版,希望对英语不好的开发者有所帮助: https://github.com/justjavac/json-api-zh_CN
|