Swagger-Client 请求超时设置详解

前言

在使用 Swagger-Client 进行 API 调用时，经常会遇到请求超时的问题。本文将深入探讨如何在 Swagger-Client 中正确设置请求超时时间，确保长时间运行的请求能够顺利完成。

问题背景

Swagger-Client 是一个流行的 JavaScript 库，用于与符合 OpenAPI/Swagger 规范的 API 进行交互。默认情况下，请求会有一定的超时限制，这对于某些需要较长时间处理的 API 操作可能不够用。

解决方案分析

传统方法尝试

最初尝试通过 requestInterceptor 或直接设置 timeout 参数的方式往往无法生效，这是因为 Swagger-Client 底层使用的是 Axios 进行 HTTP 请求，需要更底层的配置。

有效解决方案

正确的做法是通过自定义 HTTP 处理器来覆盖默认的请求行为，具体步骤如下：

1. 创建自定义的 Axios 实例
2. 在该实例上设置所需的超时时间
3. 在 execute 方法中传入自定义的 HTTP 处理器

实现代码示例

import SwaggerClient from 'swagger-client';
import axios from 'axios';

const createCustomClient = async (spec) => {
  const client = await new SwaggerClient({
    url: spec.url,
  });

  return {
    execute: async (operationId, parameters, options = {}) => {
      // 创建自定义Axios实例
      const axiosInstance = axios.create({
        timeout: options.timeout || 10000, // 默认10秒
      });

      const requestObject = {
        spec: JSON.parse(spec.data),
        operationId,
        parameters,
        http: async (request) => {
          return axiosInstance.request({
            ...request,
            data: parameters.InBodyData,
          });
        },
      };

      return client.execute(requestObject);
    },
  };
};

关键点解析

1. Axios 实例创建：通过 axios.create() 创建独立的实例，可以单独配置超时等参数
2. HTTP 处理器覆盖：使用 http 属性覆盖默认的请求处理逻辑
3. 参数传递：正确处理请求参数，特别是 body 数据

最佳实践建议

1. 合理设置超时时间：根据 API 实际响应时间设置，避免过长或过短
2. 错误处理：添加适当的错误处理逻辑，特别是对超时错误的特殊处理
3. 配置灵活性：将超时时间作为可配置参数，方便不同场景使用
4. 性能考虑：长时间运行的请求可能会占用资源，需评估系统承载能力

总结

通过自定义 Axios 实例并覆盖 Swagger-Client 的默认 HTTP 处理器，我们可以有效控制请求的超时时间。这种方法不仅解决了超时问题，还保留了 Swagger-Client 的所有其他功能，是处理长时间运行 API 请求的理想解决方案。