在 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 body 来部分更新或使用 PUT /api/users/{id} 来完全更新用户。看this包

您可以阅读Microsoft REST API Guidelines了解更多详情。