有比较流行的 JSON 接口格式规范么? - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
推荐关注
Meteor
JSLint - a Javascript code quality tool
jsFiddle
D3.js
WebStorm
推荐书目
Javascript 权威指南第 5 版
Closure: The Definitive Guide
tinyhill
V2EX    Javascript

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

  •  1
     
  •   tinyhill 2014-07-29 19:49:30 +08:00 10740 次点击
    这是一个创建于 4166 天前的主题,其中的信息可能已经有所发展或是发生改变。
    日常和开发约定 JSON 接口,每次项目都按开发个人喜好给,各种字段定义和命名规范,没法满足我强烈的代码洁癖症。今天看到个东东,有没有类似的推荐?

    传送门: http://labs.omniti.com/labs/jsend
    12 条回复    2014-10-12 22:06:11 +08:00
    eslizn
        1
    eslizn  
       2014-07-29 19:51:23 +08:00   1
    我一般就是标准http请求报文,返回的json :{status:number, msg:string, data:{...}}
    Livid
        2
    Livid  
    MOD
    PRO
       2014-07-29 20:32:31 +08:00   2
    以前我在设计 JSON 接口的时候,当时是参考看 Twitter 的 API 接口是怎么设计的。
    datou552211
        3
    datou552211  
       2014-07-29 20:37:39 +08:00   1
    https://github.com/interagent/http-api-design
    之前收藏的,看过感觉挺有帮助的。希望对你有用
    tamamaxox
        4
    tamamaxox  
       2014-07-29 20:45:25 +08:00   1
    julyclyde
        5
    julyclyde  
       2014-07-30 12:09:47 +08:00
    见过不少把status写在json内,而不用HTTP status line的
    感觉很寨

    但既然很多这么用的,自然有理由。求教到底是什么理由
    eslizn
        6
    eslizn  
       2014-08-07 12:49:16 +08:00
    @julyclyde 塞在json里的status是指业务逻辑的操作状态,比如用户注册,注册失败总不可能返个http 5xx吧
    julyclyde
        7
    julyclyde  
       2014-08-07 14:06:12 +08:00
    @eslizn RESTful的话,返回5xx挺合适的
    eslizn
        8
    eslizn  
       2014-08-07 16:26:41 +08:00
    @julyclyde 那样的话错误状态就只能定义100种咯,而且有些转发机会受http status影响,还会增加一定的开发复杂度
    julyclyde
        9
    julyclyde  
       2014-08-08 11:53:18 +08:00
    @eslizn 4xx也可以用啊
    eslizn
    10
    eslizn  
       2014-08-08 13:19:36 +08:00
    @julyclyde 那你就这样用呗
    siteshen
        11
    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
        12
    justjavac  
       2014-10-12 22:06:11 +08:00   2
    @tamamaxox 我正在翻译中文版,希望对英语不好的开发者有所帮助: https://github.com/justjavac/json-api-zh_CN
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     2947 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 24ms UTC 12:27 PVG 20:27 LAX 04:27 JFK 07:27
    Do have faith in what you're doing.
    ubao msn snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86