9、API资源关系与反模式全解析

API资源关系与反模式全解析

在API设计中，资源之间的关系设计至关重要，它直接影响着API的性能、可维护性和易用性。下面将详细探讨如何选择合适的关系、引用与内联数据的抉择、层次关系的应用，以及常见的反模式。

1. 选择合适的关系

在定义API中的引用关系时，要确保这些关系具有目的性，对API的预期行为至关重要，避免创建偶然的、可有可无的或未来可能需要的关系。例如，Twitter、Facebook和Instagram等服务围绕用户之间的关注关系构建，用户之间的自引用关系对这些服务的目标至关重要。没有这种关系，Instagram就会变成一个简单的照片存储应用。而对于直接消息服务，虽然涉及用户之间的聊天关系，但这种关系并非像前者那样对应用至关重要。

2. 引用还是内联数据

当某种关系对API的行为和功能至关重要时，需要考虑是将数据内联（在资源内部存储副本）还是使用引用（仅保留指向官方数据的指针）。以聊天室示例来说明：
假设每个聊天室必须有一个管理员用户，有两种选择：
- 通过引用字段（如 adminUserId ）指向管理员用户。
- 内联管理员用户的数据，并将其表示为 ChatRoom 资源的一部分。

以下是获取管理员用户名的代码示例：

function getAdminUserNameInline(chatRoomId: string): string {
  let chatRoomInline = GetChatRoomInline(chatRoomId)