如何在swagger-typescript-api项目中自定义Axios配置

在基于OpenAPI/Swagger规范生成TypeScript API客户端时，swagger-typescript-api是一个非常实用的工具。本文将详细介绍如何在该项目中自定义Axios配置，以满足企业级项目中对HTTP请求拦截和全局配置的特殊需求。

项目背景

swagger-typescript-api能够根据Swagger/OpenAPI规范自动生成TypeScript客户端代码，默认使用Axios作为HTTP请求库。在实际业务场景中，我们通常需要对Axios进行深度定制，包括：

1. 设置统一的请求超时时间
2. 配置全局的基础URL
3. 添加请求/响应拦截器
4. 自定义参数序列化方式
5. 实现统一的错误处理机制

自定义Axios配置方法

基础配置

在初始化生成的API客户端时，可以直接传入Axios的配置对象：

import { Api } from './generated-api';

const apiClient = new Api({
  baseURL: 'https://api.example.com',
  timeout: 10000,
  paramsSerializer: {
    indexes: null, // 禁用数组索引参数序列化
  },
  headers: {
    'Content-Type': 'application/json',
  },
});

拦截器配置

对于需要添加拦截器的场景，可以通过访问生成的API客户端实例的instance属性来配置：

// 请求拦截器
apiClient.instance.interceptors.request.use(
  (config) => {
    // 在发送请求前做些什么
    const token = localStorage.getItem('authToken');
    if (token) {
      config.headers.Authorization = `Bearer ${token}`;
    }
    return config;
  },
  (error) => {
    // 对请求错误做些什么
    return Promise.reject(error);
  }
);

// 响应拦截器
apiClient.instance.interceptors.response.use(
  (response) => {
    // 对响应数据做点什么
    return response.data; // 直接返回data部分
  },
  (error) => {
    // 对响应错误做点什么
    if (error.response?.status === 401) {
      // 处理未授权情况
      window.location.href = '/login';
    }
    return Promise.reject(error);
  }
);

高级定制方案

自定义Axios实例

如果项目已有成熟的Axios配置，可以创建自定义实例后注入：

import axios from 'axios';
import { Api } from './generated-api';

// 创建预配置的axios实例
const customAxios = axios.create({
  baseURL: process.env.API_BASE_URL,
  timeout: 15000,
});

// 添加拦截器等配置
customAxios.interceptors.request.use(/* ... */);

// 注入到生成的API客户端
const apiClient = new Api(undefined, customAxios);

类型安全扩展

为了保持类型安全，可以扩展生成的API类：

class CustomApi extends Api {
  constructor() {
    super({
      // 自定义配置
    });
    
    // 添加自定义方法
    this.specialRequest = this.specialRequest.bind(this);
  }
  
  specialRequest(params: SpecialParams) {
    return this.instance.request({
      method: 'POST',
      url: '/special-endpoint',
      data: params,
    });
  }
}

最佳实践建议

1. 环境区分：根据不同的环境(开发/测试/生产)配置不同的baseURL
2. 错误处理：实现统一的错误处理拦截器，避免在每个API调用处重复处理
3. 请求重试：对于特定错误(如网络波动)实现自动重试机制
4. 性能监控：在拦截器中添加请求耗时统计
5. 取消请求：集成AbortController实现请求取消功能

通过以上方法，开发者可以在使用swagger-typescript-api生成API客户端的同时，完全掌控Axios的配置和行为，满足企业级应用的复杂需求。