现有资源的宁静链接

Question

我不认为我的设置有任何独特之处，但我似乎找不到关于该主题的太多信息。我有一个User 实体。一个用户可以有多个Roles。角色是系统中预定义的实体，客户端无法创建新角色。但是，客户端可以从User 添加或删除Roles。我对如何实现将Role 链接到User 有一些想法，但我不确定哪个是最佳选择。

GET /users/1/roles 返回一个像这样的集合：

[
  {
    "id":1,
    "name": "ACTIVE_USER"
  },
  {
    "id":2,
    "name": "ADMIN"
  }
]

这是我目前考虑过的选项

1。正文中的角色 ID

POST /users/1/roles

{
  "roleId":1
}

2。 url中的角色ID

POST /users/1/roles/1

3。单独的用户角色端点

POST /user-roles

{
    "userId":1,
    "roleId":1
}

4。与GET /roles 相同的格式返回

POST /user/1/roles

{
  "id":1        
}

Answer 1

角色是系统中预定义的实体，客户端无法创建新角色

我建议您不要使用任何选项，因为它们都会发出 POST 请求。

记住角色是预定义的，您没有创建新角色，因此 POST 请求不合适。

相反，由于每个用户都有一个角色列表（可能是空列表，也可能不是空列表），我只需执行 PATCH 请求以使用新角色更新该角色列表。记住 PUT 是创建/替换，PATCH 是“更新”

一种可能的情况是您可以添加和删除用户的角色。所以我建议你在请求正文中添加一个操作参数：

PATCH /users/1

[
  {"action": "add", "path": "/roles", "roleId": 1}
]

为用户添加角色。对于删除，您自然会将add 替换为remove。

如果你好奇{"action": "add", "path": "/roles", "roleId": 1}的用法来自哪里，请查看this page