V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
• 请不要在回答技术问题时复制粘贴 AI 生成的内容
curiosity1901
V2EX  ›  程序员

设计基于 JSON 的 api 时,其中的 JSON 结构的 Key,大家一般参照那种命名规范?

  •  
  •   curiosity1901 · Feb 11, 2018 · 5425 views
    This topic created in 3004 days ago, the information mentioned may be changed or developed.
    比如设计一个 POST 方法的 api,Content-Type 为 application/json,其中
    1. 提交的 JSON 数据结构是哪种命名规范?
    2. 返回的 JSON 数据结构是哪种命名规范?
    另外
    3. GET 方法的 api 的 Params 中的 Key 又是哪种命名规范?

    这里有一个 Google 的一份 Style Guide 好像是推荐首字母小写的驼峰,https://google.github.io/styleguide/jsoncstyleguide.xml
    13 replies    2018-02-13 17:52:14 +08:00
    zarte
        1
    zarte  
       Feb 11, 2018
    cptbtptp
    flzxsqc
    XD
    curiosity1901
        2
    curiosity1901  
    OP
       Feb 11, 2018
    @zarte What's this? 老兄
    hsuan
        3
    hsuan  
       Feb 11, 2018 via Android
    我一般用全小写,下划线分隔
    bazingaterry
        4
    bazingaterry  
       Feb 11, 2018 via iPhone
    基本和數據庫的一樣,其實最蛋疼的是 ORM 的時候代碼是駝峰,數據庫下劃線。
    curiosity1901
        5
    curiosity1901  
    OP
       Feb 11, 2018
    @hsuan 我也是这样子,包括在公司就是这种,但是看到一些推荐用首字母小写的驼峰。我看了下 Google 和 Facebook 的部分 api,确实是这个风格,不过也看了 Instagram,发现用的是下划线。所以纠结症犯了。。。
    liuhuansir
        6
    liuhuansir  
       Feb 11, 2018 via iPhone
    @bazingaterry 这种我一般用注解转换,json 驼峰,代码驼峰,数据库字段下划线
    curiosity1901
        7
    curiosity1901  
    OP
       Feb 11, 2018
    @liuhuansir 数据库的命名好像不区分大小写,所以比较推荐下划线
    curiosity1901
        8
    curiosity1901  
    OP
       Feb 11, 2018
    很多 ORM 在生成数据表的时候应该会自动转化成下划线风格的命名
    doublelam
        9
    doublelam  
       Feb 11, 2018
    这个,个人感觉吧,如果是 nodejs 或者 java 之类的首字母小写,驼峰命名很自然,如果比如用 python,是不是有点怪怪的?
    sothx
        10
    sothx  
       Feb 12, 2018 via iPhone
    我一般 JSON 都是小驼峰。
    parmas 一般就是下划线分开。
    goinghugh
        11
    goinghugh  
       Feb 12, 2018
    和语言相关吧,用 java 写后端很自然就写成驼峰了;用 python 写后端,很自然就写成下划线了..
    panpanpan
        12
    panpanpan  
       Feb 12, 2018
    驼峰难道不是因为 Java 的编码规范中推荐使用驼峰吗?所以返回就是驼峰了,接收参数也是驼峰
    keysaim
        13
    keysaim  
       Feb 13, 2018 via iPhone
    只要不要直接返回数组 尽量遵循 http 规范 至于下划线还是驼峰 你固定一种就可以了。如果你用 Go 的话 推荐驼峰
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   2557 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 39ms · UTC 05:28 · PVG 13:28 · LAX 22:28 · JFK 01:28
    ♥ Do have faith in what you're doing.