api - RESTful API - URI 结构建议

Question

我的 REST API URL 结构类似于:

/api/contacts                 GET          Returns an array of contacts
/api/contacts/:id             GET          Returns the contact with id of :id
/api/contacts                 POST         Adds a new contact and return it with an id added
/api/contacts/:id             PUT          Updates the contact with id of :id
/api/contacts/:id             PATCH        Partially updates the contact with id of :id
/api/contacts/:id             DELETE       Deletes the contact with id of :id

我的问题是关于:

/api/contacts/:id             GET

假设除了通过ID获取联系人之外，我还想通过唯一的别名获取它。

如果我希望能够通过 ID 或别名获取联系人，URI 结构应该是什么？

Answer 1

如果您的别名不是数字，我建议您使用相同的 URI 结构并确定它是您的 ID 还是别名。就像 Facebook 对用户名和 user_id 所做的一样。 facebook.com/user_id 或 facebook.com/username。

另一种方法是让客户端使用 GET/contacts 和一些额外的 GET 参数作为过滤器，首先搜索联系人，然后从该响应中查找 ID。

我认为最后一个选择是使用像 GET/contacts/alias/:alias 这样的结构。但这有点暗示别名是联系人的子资源。