RESTful API设计（资源连接）

Question

我正在为我的 Web 项目 (PHP) 设计一个 API，但在对资源与属性之间的关系进行建模时遇到了麻烦。我想获得一些关于如何继续的意见。

资源：

• 用户。
  • 同上。
  • 姓名。
  • 狗（关系）。
    • 同上。
    • 私人（是或否）。
• 狗。
  • 同上。
  • 姓名。

关系：

• 多对多。
  • 一个用户可以养多只狗。
  • 一只狗可以属于多个用户。
• 该关系可以是私人的或公开的。

您想如何更新关系的“私有”属性？

现在，您必须向 .../api/users/{userId} 发送 PUT 请求，包括该用户的所有关系，包括更新的属性：（

名称可以为 NULL -> 无更新）

• 狗：
  • 狗。
    • ID：DogA。
    • 私人：是的。
  • 狗。
    • ID：DogB。
    • 私人：否。（已更新）

我对这种方法感到不舒服，因为我相信只有已更改的信息才需要发送以进行更新。因此，我现在的想法是添加对仅将更新后的关系发送到 .../api/users/{userId}:

• Dogs 的支持。
  • 狗。
    • ID：DogB。
    • 私人：否。（已更新）

在开始工作之前，我非常感谢一些反馈。也许还有其他更好的方法来处理资源之间的关系？

Answer 1

这样做会违反 REST 服务幂等的原则。这意味着您应该能够发送相同的操作两次，而无需更改第二次操作的资源。

我会将这种关系视为单独的资源：
创建/更新将是 PUT ../api/users/{userId}/dogs/{dogId} ，其中 Private: Yes/No。删除关系将由 DELETE ../api/users/{userId}/dogs/{dogId} 处理。