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中这三种选项都是技术上允许的，但是它们之间是否存在任何技术陷阱可以通过选择其中一种来避免呢？例如，由于编程语言中广泛使用点符号表示法，我们是否应该避免在字段名称中使用点“.”呢？

非常感谢您的建议。

- ryan

Answer 1

最终取决于您和您的开发人员最熟悉的方式。我个人在所有变量、HTTP_POST或编程中使用camelCase。我建议使用camelCase或snake_case，但是camelCase最受欢迎。

点表示法是最糟糕的命名约定之一，您已经说明了原因。如果您在表单上使用任何使用点表示法进行函数或其他对象相关任务的语言，则可能会遇到问题。例如：JavaScript-不是一个好的例子，但大多数函数都是点表示法。

- James Williams