Hey API Axios客户端0.4.0版本发布：认证机制重大升级

Hey API是一个基于OpenAPI规范的TypeScript客户端生成工具，它能够根据OpenAPI文档自动生成类型安全的API客户端代码。其中@hey-api/client-axios是基于Axios的HTTP客户端实现，为开发者提供了便捷的API调用方式。

在最新发布的0.4.0版本中，@hey-api/client-axios对认证机制进行了重大重构，这是该版本最核心的变更。本文将详细介绍这些变更内容及其对开发者的影响。

认证机制重构

统一认证接口

在之前的版本中，客户端提供了两个独立的函数来处理不同类型的认证：

• accessToken：用于处理OAuth等基于令牌的认证
• apiKey：用于处理API密钥认证

0.4.0版本将这些分散的认证方法统一为一个auth函数。这种设计更加符合现代API开发中常见的多认证机制场景。新的auth函数接收一个参数，开发者可以根据需要返回适当的认证令牌。

// 旧版配置方式
client.setConfig({
  accessToken: () => '<my_token>',
  apiKey: () => '<my_token>',
});

// 新版配置方式
client.setConfig({
  auth: (auth) => '<my_token>',
});

移除Axios原生auth支持

由于与Axios原生的auth配置选项存在命名冲突，新版本移除了对Axios原生认证机制的支持。这一变更可能会影响那些依赖Axios原生认证特性的项目。如果这一功能对你的项目至关重要，建议向维护团队反馈以评估是否需要在未来版本中重新引入。

接口重命名

另一个重要变更是将Security接口重命名为Auth。这一变更使接口命名更加语义化，更准确地反映了其用途。开发者需要注意在升级时更新相关代码中的接口引用。

升级建议

1. 确保同时升级@hey-api/openapi-ts到最新版本，以获得完整的兼容性支持
2. 检查项目中所有使用accessToken和apiKey的地方，将其替换为新的auth函数
3. 更新所有Security接口引用为Auth
4. 如果项目依赖Axios原生认证，需要寻找替代方案或等待后续版本支持

总结

0.4.0版本的认证机制重构使@hey-api/client-axios更加灵活和一致，特别是对于支持多种认证方式的API。虽然这些变更是破坏性的，但它们为未来的功能扩展奠定了更好的基础。开发者应仔细评估升级影响，并按照建议步骤进行迁移。

对于需要帮助的开发者，建议查阅项目的文档或与社区交流，以获取更多关于这些变更的详细信息和迁移指导。