25、API设计中的单例子资源与交叉引用模式解析

API设计中的单例子资源与交叉引用模式解析

在API设计领域，单例子资源和交叉引用是两个重要的概念，它们各自有着独特的设计思路和应用场景，同时也伴随着一些需要权衡的因素。下面我们将深入探讨这两种模式。

单例子资源模式

单例子资源模式在API设计中有着特定的规则和应用场景。

1. 必需的父资源

单例子资源必须从属于某个父资源，不能直接挂载在API层次结构的根级别。这是因为全局单例在功能上等同于全局共享锁，一个资源实例会被API的所有潜在消费者共享。这种共享方式会导致严重的写冲突，所有的写操作都会集中到单个资源上。

2. 完整资源父级

另一个需要考虑的边界情况是，单例子资源是否可以有自己的单例子资源。实际上，如果一个单例子资源作为其他单例的父资源，那么这些子资源应该作为该父资源的兄弟资源。因为让一个单例作为另一个单例的父资源并没有实际的价值。

3. 最终API定义

以一个包含Driver资源和DriverLocation单例子资源的示例服务为例，其最终的API定义如下：

abstract class RideSharingApi {
  static version = "v1";
  static title = "Ride Sharing API";
  @get("/drivers")
  ListDrivers(req: ListDriversRequest): ListDriversResponse;
  @post("/drivers")
  CreateDriver(re