如何为双向实体映射设计端点

Question

有两个实体，User 和 Order。 User 实体有一个Set<Order> 的订单，它是一个双向映射。

现在我有两个控制器，一个控制器叫做OrderController，它有一些端点来检索所有订单等。第二个控制器叫做UserController，它有一些与用户相关的端点，但它也有/users/{username}/orders 和 /users/{username}/orders/{orderId} 等端点。

问题是我应该在哪里添加端点来持久化订单？它应该是OrderController 中的POST，即/orders，还是应该在UserController 中作为/users/{username}/orders 端点？订单由用户创建，OrderController 仅用于检索所有订单，而不仅仅针对特定用户。

你对它应该如何设计有什么建议吗？

Answer 1

Zalando API Guideline 对这个问题有一些看法，他们建议我们应该限制资源类型的数量，原因如下：

为了保持维护和服务发展的可控性，我们应该遵循 “功能分割”和“关注点分离”设计 原则，不要将不同的业务功能混在同一个 API 定义。在实践中，这意味着资源的数量 通过 API 公开的类型应该受到限制。在这种情况下，资源 类型被定义为一组高度相关的资源，例如 集合、其成员和任何直接子资源。

适用于您的情况，基本上他们建议只有以下资源类型：

• /用户
• /订单

并且没有必要让/users/{username}/orders/ 像/orders 已经用于相同的目的。如果您想为用户获取订单，只需使用/orders?user=foobar