REST API设计-通过具有不同参数但相同url模式的REST获取资源

Question

我有一个与REST url设计相关的问题。我在这里找到了一些相关的帖子：相同资源的不同RESTful表示，在这里：通过不同字段获取资源的RESTful url，但对于最佳实践是什么以及为什么，这些回复并不十分清楚。这里有一个例子。

我有表示“用户”资源的REST URL。我可以获得一个具有id或电子邮件地址的用户，但两者的URL表示形式保持不变。通过大量的博客和书籍，我看到人们一直在用很多不同的方式来做这件事。例如：

在stackoverflow的书和某个地方读过这个实践（我似乎再也找不到链接了）

GET /users/id={id}
GET /users/email={email}

GET /users/{id}
GET /users/email/{email}

GET /users?id={id}
GET /users?email={email}

感谢所有的帮助！

Answer 1

根据我的经验，GET/users/{id}GET/users/email/{email}是最常见的方法。如果不存在具有所提供的ID或email的用户，我还希望方法返回404 Not Found。看到get/users/id/{id}我也不会感到惊讶（尽管在我看来，这是多余的）。

• 获取/users/id={id}获取/users/email={email}
  • 我想我没见过这个，而且如果我真的见过，那会很混乱的。这几乎就像它试图用路径参数来模仿查询参数。
  • 我认为您提到使用查询参数进行筛选时一针见血。
  • 同时使用id和email调用此资源（例如get/users？id={id}&email={email})是否有意义？如果不是，我就不会使用这样的单一资源方法。
  • 我希望使用此方法检索具有可选查询参数的用户列表以进行筛选，但不希望参数中包含id、email或任何唯一标识符。例如:get/users？status=bank可能返回被禁用户的列表。