OpenAPI Generator之TypeScript（实验版）如何设置API Key？

typescript-fetch生成器的实现方式 #

对于typescript-fetch生成器，直接在创建API实例时传入包含apiKey的Configuration对象即可：

const api = new DefaultApi(new Configuration({ 
  apiKey: apiEndpoints.warnings_api_key, 
  basePath
}))

实验版TypeScript生成器的替代方案 #

如果是实验版TypeScript生成器（即typescript生成器，区别于typescript-fetch），它本身不支持直接传入apiKey参数，可通过以下两种方式解决：

• 手动在请求头中添加API Key
  生成的API方法通常支持传入headers参数，可直接在调用时添加API Key对应的请求头（比如自定义的X-API-Key或标准的Authorization头）：

  const api = new DefaultApi();
  const response = await api.someApiMethod({
    headers: {
      'X-API-Key': apiEndpoints.warnings_api_key
    }
  });
  

• 全局统一注入API Key
  若希望所有请求自动携带API Key，可以封装工具函数生成统一的请求配置，或者修改生成的API类中的默认请求初始化逻辑，实现全局注入：

  // 封装带API Key的请求配置
  function getApiConfig() {
    return {
      headers: {
        'X-API-Key': apiEndpoints.warnings_api_key
      }
    };
  }
  
  // 调用API时复用配置
  const api = new DefaultApi();
  const response = await api.someApiMethod(getApiConfig());
  

内容的提问来源于stack exchange，提问作者Aximili