REST API:我们可以对查询使用复数命名吗?

时间:2018-04-06 10:17:27

标签: rest api naming-conventions

假设我们要将客户端ID列表发送到某个端点。我们应该使用“客户”或“客户”这个名称来查询吗?我认为这两种情况都有利有弊,但这有什么约定吗?

GET https://somedomain.com/some/endpoint?client(s)=1&client(s)=2

1 个答案:

答案 0 :(得分:0)

REST不关心您用于资源标识符的拼写。编码到标识符中的任何信息都由服务器自行决定并由其自己独占使用。

部分原因是:作为服务器,您希望能够更改将信息编码为URI的方式,以使其更好地适用于您的基础架构。

例如,如果您正在使用可以自动处理列表参数的查询字符串解析库,只要它们匹配某个特定模式,那么您希望能够利用它。

因此查询参数的拼写约定是本地选择;非常类似于代码中变量名称的拼写是本地选择的方式。