有比较流行的 JSON 接口格式规范么？

V2EX = way to explore

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

现在注册

已注册用户请登录

推荐关注

› Meteor

› JSLint - a JavaScript code quality tool

› jsFiddle

› D3.js

› WebStorm

推荐书目

› JavaScript 权威指南第 5 版

› Closure: The Definitive Guide

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

日常和开发约定 JSON 接口，每次项目都按开发个人喜好给，各种字段定义和命名规范，没法满足我强烈的代码洁癖症。今天看到个东东，有没有类似的推荐？

传送门： http://labs.omniti.com/labs/jsend

JSON

字段

接口

12 条回复 • 2014-10-12 22:06:11 +08:00

eslizn

2014-07-29 19:51:23 +08:00

我一般就是标准http请求报文,返回的json :{status:number, msg:string, data:{...}}

Livid

MOD

2014-07-29 20:32:31 +08:00

以前我在设计 JSON 接口的时候，当时是参考看 Twitter 的 API 接口是怎么设计的。

datou552211

2014-07-29 20:37:39 +08:00

https://github.com/interagent/http-api-design
之前收藏的，看过感觉挺有帮助的。希望对你有用

tamamaxox

2014-07-29 20:45:25 +08:00

http://jsonapi.org/

julyclyde

2014-07-30 12:09:47 +08:00

见过不少把status写在json内，而不用HTTP status line的
感觉很寨

但既然很多这么用的，自然有理由。求教到底是什么理由

eslizn

2014-08-07 12:49:16 +08:00

@julyclyde 塞在json里的status是指业务逻辑的操作状态,比如用户注册,注册失败总不可能返个http 5xx吧

julyclyde

2014-08-07 14:06:12 +08:00

@eslizn RESTful的话，返回5xx挺合适的

eslizn

2014-08-07 16:26:41 +08:00

@julyclyde 那样的话错误状态就只能定义100种咯,而且有些转发机会受http status影响,还会增加一定的开发复杂度

julyclyde

2014-08-08 11:53:18 +08:00

@eslizn 4xx也可以用啊

eslizn

2014-08-08 13:19:36 +08:00

@julyclyde 那你就这样用呗

siteshen

2014-08-08 18:14:43 +08:00

@julyclyde 理由之一是方便客户端处理，客户端可以无脑解析body（某些客户端http请求返回非2xx状态码时异常），统一处理。现在我们的方式是，status line里有写，json body里也有写（相同），客户端爱咋搞咋搞。

@tinyhill 我司的JSON接口字段定义绝大部分按DB定义中的来，尽量保持API和DB的一致（好了，现在引入了另外一个问题“有比较流行的数据库字段命名规范么”）。
另 1.我司的API在JSend基础上增加了meta字段，添加额外信息（next_url, elapsed_ms）等；

随口吐个槽，这个怎么会放在JavaScript这个节点下面？不应该是API设计之类的节点吗？

justjavac

2014-10-12 22:06:11 +08:00

@tamamaxox 我正在翻译中文版，希望对英语不好的开发者有所帮助： https://github.com/justjavac/json-api-zh_CN