ruby-on-rails - 对 HTTP POST 参数命名约定的偏好？

Question

我们正在用 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 中在技术上都是允许的，但是我们可以通过使用其中一个来避免任何技术陷阱吗？例如，我们是否应该避免使用点“.”？由于在编程语言中普遍使用“点符号”而导致在字段名称中？

如有任何建议，我们将不胜感激。

Answer 1

最终归结为您和您的开发人员最满意的内容。我个人对我的所有变量、HTTP_POST 或编程都使用驼峰命名法。我会坚持使用 camelCase 或 snake_case，尽管 camelCase 最受欢迎。

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