推荐关注
Meteor
JSLint - a JavaScript code quality tool
jsFiddle
D3.js
WebStorm
推荐书目
JavaScript 权威指南第 5 版
Closure: The Definitive Guide
tinyhill

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

  •  1
     
  •   tinyhill · Jul 29, 2014 · 10929 views
    This topic created in 4332 days ago, the information mentioned may be changed or developed.
    日常和开发约定 JSON 接口,每次项目都按开发个人喜好给,各种字段定义和命名规范,没法满足我强烈的代码洁癖症。今天看到个东东,有没有类似的推荐?

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

    但既然很多这么用的,自然有理由。求教到底是什么理由
    eslizn
        6
    eslizn  
       Aug 7, 2014
    @julyclyde 塞在json里的status是指业务逻辑的操作状态,比如用户注册,注册失败总不可能返个http 5xx吧
    julyclyde
        7
    julyclyde  
       Aug 7, 2014
    @eslizn RESTful的话,返回5xx挺合适的
    eslizn
        8
    eslizn  
       Aug 7, 2014
    @julyclyde 那样的话错误状态就只能定义100种咯,而且有些转发机会受http status影响,还会增加一定的开发复杂度
    julyclyde
        9
    julyclyde  
       Aug 8, 2014
    @eslizn 4xx也可以用啊
    eslizn
        10
    eslizn  
       Aug 8, 2014
    @julyclyde 那你就这样用呗
    siteshen
        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设计之类的节点吗?
    justjavac
        12
    justjavac  
       Oct 12, 2014   ❤️ 2
    @tamamaxox 我正在翻译中文版,希望对英语不好的开发者有所帮助: https://github.com/justjavac/json-api-zh_CN
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   939 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 60ms · UTC 21:01 · PVG 05:01 · LAX 14:01 · JFK 17:01
    ♥ Do have faith in what you're doing.