14、API 标准方法详解

API 标准方法详解

在 API 开发中，标准方法的使用至关重要。它们不仅能提高 API 的一致性和可维护性，还能让开发者更高效地处理资源。下面将详细介绍几种常见的 API 标准方法。

1. Get 方法

Get 方法的目标非常明确，它用于从服务中获取存储的资源记录。该方法只接受一个输入，即资源的唯一标识符，本质上是对存储数据的键值查找。

以下是一个标准 Get 方法的示例：

abstract class ChatRoom {
  @get("/{id=chatRooms/*}")  // #A 
  GetChatRoom(req: GetChatRoomRequest): ChatRoom;  // #B 
} 

interface GetChatRoomRequest {
  id: string;
}

• A：标准 Get 方法总是通过资源的唯一标识符来检索资源。

• B：标准 Get 方法的结果应该始终是资源本身。

与大多数不主动更改底层数据的方法一样，Get 方法应该是幂等的。这意味着在没有其他并发更改的情况下，多次运行该方法的结果应该相同，并且该方法不应有明显的副作用。

2. List 方法

由于标准 Get 方法只能进行键值查找，因此需要另一种机制来浏览可用资源，List 方法就是为此而生。在 List 方法中，你需要指定要浏览的特定集合，结果将是属于该集合的所有资源的列表。