Hey API TypeScript 客户端新增只读/只写字段支持

Hey API 是一个开源的 TypeScript OpenAPI 客户端生成工具，它能够根据 OpenAPI 规范自动生成类型安全的 API 客户端代码。在最新发布的 0.66.0 版本中，该工具新增了对 OpenAPI 规范中只读(read-only)和只写(write-only)字段的支持，这为开发者提供了更精确的类型定义和更好的开发体验。

只读/只写字段的背景

在 RESTful API 设计中，经常会出现某些字段在不同场景下具有不同的访问权限。例如：

• 只读字段：通常是由服务器自动生成的字段，如创建时间(created_at)、ID等，客户端不能修改这些字段
• 只写字段：如密码字段，客户端可以发送给服务器，但服务器永远不会返回

OpenAPI 3.0 规范通过 readOnly 和 writeOnly 属性来标记这些特殊字段，帮助开发者更清晰地理解API的契约。

新版本的核心改进

在 0.66.0 版本之前，Hey API TypeScript 客户端会为每个模型生成单一的类型定义，不考虑字段的读写特性。这可能导致类型定义不够精确，例如：

• 在创建请求中，类型系统不会阻止开发者设置只读字段
• 在响应类型中，开发者可能会错误地认为可以访问只写字段

新版本通过以下方式改进了这一情况：

1. 自动分离类型：当检测到模型包含只读或只写字段时，会自动生成两个独立的类型：

   • Payload 类型：用于请求体，不包含只读字段
   • Response 类型：用于响应体，不包含只写字段

2. 配置选项：新增了 readOnlyWriteOnlyBehavior 配置项，开发者可以选择：

   • auto（默认）：自动分离类型
   • off：保持旧版行为，生成单一类型

实际应用示例

假设我们有一个用户模型，其中包含：

• id：只读字段（服务器生成）
• password：只写字段（不会在响应中返回）
• username：普通字段

新版本会生成如下类型：

// 请求体类型（用于创建/更新用户）
interface UserPayload {
  username: string;
  password: string;
}

// 响应体类型（用于获取用户信息）
interface UserResponse {
  id: string;
  username: string;
}

这种分离使得类型系统能够更准确地反映API的实际行为，帮助开发者在编译时捕获潜在的错误。

向后兼容性

考虑到现有项目可能依赖于旧版行为，Hey API 提供了 readOnlyWriteOnlyBehavior: 'off' 选项来禁用这一特性。这确保了升级的平滑性，同时为需要更精确类型的新项目提供了选择。

最佳实践建议

1. 新项目：建议保持默认的 auto 设置，以获得最精确的类型检查
2. 现有项目：评估是否启用此特性，如果代码中已经存在对只读字段的赋值操作，可能需要先修复这些地方
3. API设计：在设计OpenAPI规范时，明确标记只读和只写字段，以便生成更准确的客户端代码

这一改进使得Hey API TypeScript客户端在类型安全性方面更进一步，为开发者提供了更强大的工具来构建健壮的API集成代码。