16、资源导向型 API 标准方法全解析

资源导向型 API 标准方法全解析

在资源导向型 API 的开发与使用中，标准方法起着至关重要的作用。它们为开发者提供了一套通用的操作规范，使得 API 的使用更加高效和可预测。下面将详细介绍创建、更新、删除等常见的标准方法。

创建资源

创建资源是向 API 中添加数据的主要方式。标准创建方法的目标很简单：根据提供的资源信息，在 API 中创建新的资源，以便通过其标识符进行检索或通过列出资源的方式发现它。以下是创建 ChatRoom 和 Message 资源的示例代码：

abstract class ChatRoomApi {
  @post("/chatRooms")                       
  CreateChatRoom(req: CreateChatRoomRequest): ChatRoom;   
  @post("/{parent=chatRooms/*}/messages")   
  CreateMessage(req: CreateMessageRequest): Message;      
}

interface CreateChatRoomRequest {
  resource: ChatRoom;
}

interface CreateMessageRequest {
  parent: string;
  resource: Message;
}

在这个示例中，标准创建方法使用 HTTP POST 动词。请求中包含了资源的相关信息，响应总是返回新创建的资源。