【问题标题】:REST API: Can we use plural naming for queries?REST API:我们可以对查询使用复数命名吗?
【发布时间】:2018-09-16 08:22:11
【问题描述】:

假设我们想向某个端点发送一个客户端 ID 列表。我们应该使用名称“client”还是“clients”进行查询?我认为这两种情况都有利有弊,但是对此有什么约定吗?

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

【问题讨论】:

  • 使用常识:如果您允许列出客户端 ID 的clients 是有意义的。如果您希望每个客户端 ID 有一个参数,则应为 client

标签: rest api naming-conventions


【解决方案1】:

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

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

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

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

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2013-08-06
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2023-03-24
    • 1970-01-01
    • 2014-12-15
    • 2021-03-20
    相关资源
    最近更新 更多