【问题标题】:Preference for HTTP POST parameter naming convention?HTTP POST 参数命名约定的偏好?
【发布时间】:2011-12-30 18:03:49
【问题描述】:

我们正在 Rails 中构建一个小型 Web 应用程序,它允许客户端通过 HTTP POST API 进行交互;典型的客户端是另一个应用程序,例如 HTML 表单或移动应用程序。

我们正在决定 API 字段名称,即 POST 参数名称。我们想知道是否应该遵循特定的命名约定?例如。 snake_case、camelCase 等

一些例子:

OPTION 1
employee.address.line_1=value

OPTION 2
employee_address_line_1=value

OPTION 3
employeeAddressLine1=value

我们知道在 HTTP POST 中所有三个选项在技术上都是允许的,但是我们可以通过使用其中一个来避免任何技术缺陷吗?例如,我们是否应该避免使用点“。”由于在编程语言中普遍使用“点表示法”,在字段名称中?

任何建议将不胜感激。

【问题讨论】:

    标签: ruby-on-rails api http post


    【解决方案1】:

    最终归结为您和您的开发人员最满意的是什么。我个人对所有变量、HTTP_POST 或编程都使用 camelCase。我会坚持使用camelCase 或snake_case,虽然camelCase 是最受欢迎的。

    点表示法是最糟糕的命名约定形式之一,您已经说明了原因。如果您碰巧在表单上使用任何将点表示法用于函数或其他与对象相关的任务的语言,您可能会遇到问题。 EX:javascript - 不是一个很好的例子,但大多数函数都用点表示。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2010-10-01
      • 1970-01-01
      • 2018-08-31
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多