如何在AWS Amplify v6中为REST API调用设置超时时间？

Amplify v6对REST API的请求配置做了破坏性变更，原v5请求级的timeout参数不再被支持，可通过以下两种方式设置超时：

1. 全局配置默认超时 #

在Amplify初始化时，针对目标REST API配置全局的fetchTimeout，适用于该API下的所有请求：

import { Amplify } from 'aws-amplify';
import amplifyConfig from './amplifyconfiguration.json';

Amplify.configure({
  ...amplifyConfig,
  API: {
    REST: {
      // 替换为你的API名称
      [YOUR_API_NAME]: {
        endpoint: amplifyConfig.API.REST[YOUR_API_NAME].endpoint,
        fetchTimeout: 120000, // 2分钟，单位毫秒
      },
    },
  },
});

2. 请求级自定义超时（适配测试场景） #

如果需要针对单个请求设置不同超时（比如你的Cypress测试需要5秒超时），可以通过AbortController手动实现超时逻辑，封装请求方法：

import { post } from 'aws-amplify/api';

async function postWithTimeout(apiName, path, options = {}, timeout = 5000) {
  const abortController = new AbortController();
  const timeoutId = setTimeout(() => abortController.abort(), timeout);

  try {
    const response = await post({
      apiName,
      path,
      options: {
        ...options,
        signal: abortController.signal,
      },
    });
    clearTimeout(timeoutId);
    return response;
  } catch (error) {
    if (error.name === 'AbortError') {
      throw new Error('Request timed out');
    }
    throw error;
  }
}

// Cypress测试调用示例
cy.wrap(postWithTimeout('your-api-name', '/path', { headers, body }, 5000))
  .should('throw', 'Request timed out');

关键说明 #

• Amplify v6的REST API底层基于标准fetch API，而fetch本身不支持原生timeout参数，因此原v5的请求级timeout参数被移除。
• 全局配置的fetchTimeout是Amplify封装的便捷方式，内部同样通过AbortController实现超时逻辑。
• 测试场景下使用请求级超时可灵活控制单请求的超时时间，满足Cypress快速验证超时响应的需求。

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