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

最终归结为您和您的开发人员最满意的内容。我个人使用camelCase来处理我的所有变量，HTTP_POST或编程。我会坚持使用camelCase或snake_case，但是camelCase最受欢迎。

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