确定REST体系结构中的适当URI和资源

Question

我对REST体系结构还比较陌生，对于如何为我的项目实现RESTful API提出了一些疑问。

哪些URI和资源适合：

1。登录并注销？

我猜是POST or DELETE /api/users/auth还是POST or DELETE /api/users/login？

2。设置，删除或获取用户的头像？

我猜：POST or DELETE or GET /api/users/{id}/avatar。正确吗？

3。通过发送的代码验证吗？

我猜：POST /api/users/{id}/verification。正确吗？

4。更改用户的单个或某些特定属性？ （例如，更改电子邮件或用户名）

我猜是：PACTH /api/users/{id}或PUT /api/users/{id}/email。正确吗？

谢谢。

Answer 1

1。登录并注销？

对于Web API，您必须实现OAuth Authorization，然后使用

POST /oauth获得令牌

2。设置，删除或获取用户的头像？

没有特定的规则，但是人类应该能够轻松地阅读和构造URL。所以，我认为会没事的

POST or DELETE or GET /api/users/{id}/avatar

3。通过发送的代码验证吗？

由您决定。

4。更改用户的单个或某些特定属性？ （例如，更改电子邮件或用户名）

在这里，我建议使用PACTH /api/users/{id}和json正文进行部分更新，或使用PUT /api/users/{id}进行完全更新。查看this软件包

您可以阅读Microsoft REST API Guidelines以获得更多详细信息。