Redux Toolkit 代码生成器新增 HTTP 请求头配置功能

在最新发布的 Redux Toolkit 代码生成工具中，开发团队为 @rtk-query/codegen-openapi 包添加了一项重要功能：支持配置 HTTP 请求头。这一改进解决了开发者在使用 OpenAPI/Swagger 规范生成 API 代码时遇到的身份验证难题。

背景与痛点

许多现代 API 服务都会将 Swagger 文档置于身份验证保护之后。在之前的版本中，开发者在使用 RTK Query 代码生成器时，无法直接访问这些受保护的文档。常见的变通方案包括：

1. 在本地运行服务器并临时禁用身份验证
2. 手动下载文档文件再提供给生成器
3. 修改 CI/CD 流程以绕过安全限制

这些方法不仅增加了开发复杂度，还可能引入安全隐患或导致开发环境与生产环境不一致的问题。

技术实现

新版本通过暴露 swagger-parser 的 HTTP 解析器选项解决了这一问题。开发者现在可以在配置文件中直接指定 HTTP 请求头，就像普通的 API 调用一样。

核心配置项是一个新的 httpResolverOptions 字段，它接收一个包含 headers 属性的对象。这个机制与常见的 HTTP 客户端（如 fetch 或 axios）的配置方式非常相似，降低了学习成本。

使用示例

以下是一个完整的配置示例，展示了如何为受 Basic Auth 保护的 Swagger 文档设置认证头：

import type { ConfigFile } from '@rtk-query/codegen-openapi'

const config: ConfigFile = {
  schemaFile: 'https://api.example.com/openapi.json',
  apiFile: './src/store/emptyApi.ts',
  apiImport: 'emptySplitApi',
  outputFile: './src/store/exampleApi.ts',
  exportName: 'exampleApi',
  hooks: true,
  httpResolverOptions: {
    headers: {
      Accept: 'application/json',
      Authorization: 'Basic base64编码的凭据'
    }
  }
}

export default config

最佳实践

1. 安全考虑：建议将敏感凭证存储在环境变量中，而不是直接硬编码在配置文件中
2. 内容协商：始终设置 Accept 头以确保服务器返回预期的文档格式
3. 缓存策略：对于大型文档，考虑配置适当的缓存控制头以提高生成效率
4. 错误处理：确保为认证失败的情况提供清晰的错误信息

版本兼容性

该功能从 @rtk-query/codegen-openapi@2.0.0-alpha.0 开始提供。开发者可以通过检查项目依赖版本或查看更新日志来确认是否包含此功能。

这一改进显著提升了 Redux Toolkit 代码生成器在企业环境中的适用性，使开发者能够更安全、更方便地集成受保护的 API 文档。