36、API资源过滤与导入导出功能解析

API资源过滤与导入导出功能解析

1. API资源过滤

在API开发中，资源过滤是一项重要功能。过滤资源的API定义相对简单，仅需在标准列表请求中更新以包含过滤字段。以下是最终的API定义示例：

abstract class ChatRoomApi {
  @get("/chatRooms")
  ListChatRooms(req: ListChatRoomsRequest): ListChatRoomsResponse;
}

interface ListChatRoomsRequest {
  filter: string;
  maxPageSize: number;
  pageToken: string;
}

interface ListChatRoomsResponse {
  resources: ChatRoom[];
  nextPageToken: string;
}

在这个定义中， ListChatRoomsRequest 接口包含一个 filter 字段，类型为字符串。这一设计决策非常重要，使用字符串类型的过滤字段，便于在不更新技术API规范的情况下管理结构格式的变化。

1.1 权衡支持过滤的利弊

是否支持过滤存在明显的权衡。在标准列表请求中提供资源过滤功能通常会消耗更多资源，但为用户带来的好处几乎肯定超过任何短期的额外成本。如果用户被迫通过获取所有资源来进行“自行过滤”，不仅浪费自己的时间，还会浪费API的计算资源来检索和传输大量本可以提前过滤掉的信息。因此，对