api-speed-tester

一个用于测试多个 API 域名响应速度的 TypeScript 工具，帮助选择最快的 API 线路。

✨ 特性

• 🚀 并发测试: 同时测试多个 API，最快结果立即返回
• ⚡ 即时响应: 最快成功的 API 立即可用，其他继续测试
• ⏱️ 响应时间测量: 精确测量每个 API 的响应时间
• ✅ 内容验证: 验证响应内容是否符合期望
• ⏰ 超时控制: 可配置超时时间，避免长时间等待
• 📊 结果排序: 自动按响应时间和成功状态排序
• 📝 详细日志: 提供清晰的测试过程和结果展示
• 🔧 TypeScript: 完整的类型支持和 TSDoc 注释
• 📦 零配置: 开箱即用，无需复杂配置
• 🌐 基于 Axios: 使用成熟的 HTTP 客户端库

📦 安装

npm install api-speed-tester

或使用其他包管理器：

# 使用 yarn
yarn add api-speed-tester

# 使用 pnpm
pnpm add api-speed-tester

🚀 快速开始

基本用法

import { ApiSpeedTester } from 'api-speed-tester';

const tester = new ApiSpeedTester({
  domains: [
    'api1.example.com',
    'api2.example.com',
    'api3.example.com'
  ],
  testPath: '/api/test',
  expectedResponse: { success: true },
  timeout: 5000
});

// 最快线路成功后立即返回，其他线路继续测试
const { fastest, allResults } = await tester.getBestRoute();

if (fastest) {
  console.log(`⚡ 最快线路: ${fastest.domain} (${fastest.responseTime}ms)`);
  // 立即开始使用最快线路处理业务请求
  startUsingFastestRoute(fastest.domain);
}

// 等待所有测试完成，获取完整排序结果
const sortedResults = await allResults;
console.log('📊 所有结果按响应时间排序:', sortedResults);

📋 API 文档

ApiTestConfig

配置接口，用于定义测试参数。

| 参数 | 类型 | 必填 | 默认值 | 说明 | |------|------|------|--------|------| | domains | string[] | ✅ | - | API 域名列表 | | testPath | string | ✅ | - | 测试路径（如 /health） | | expectedResponse | any | ✅ | - | 期望的响应内容 | | timeout | number | ❌ | 5000 | 超时时间（毫秒） | | headers | Record<string, string> | ❌ | {} | 自定义请求头 |

ApiTestResult

测试结果接口，包含每个 API 的测试信息。

| 字段 | 类型 | 说明 | |------|------|------| | domain | string | API 域名 | | responseTime | number | 响应时间（毫秒） | | success | boolean | 是否测试成功 | | data | any | 响应数据（成功时） | | error | string | 错误信息（失败时） |

ApiSpeedTester 类

构造函数

constructor(config: ApiTestConfig)

创建 API 速度测试器实例。

方法

getBestRoute(): Promise<{ fastest: ApiTestResult | null, allResults: Promise<ApiTestResult[]> }>

并发测试所有线路，最快成功的线路立即返回，其他线路继续测试。返回最快结果和所有结果的 Promise。

const { fastest, allResults } = await tester.getBestRoute();

if (fastest) {
  console.log(`⚡ 最快线路: ${fastest.domain} (${fastest.responseTime}ms)`);
  // 立即开始使用最快线路
  startUsingRoute(fastest.domain);
}

// 等待所有测试完成
const sortedResults = await allResults;
console.log('完整测试结果:', sortedResults);

🔧 开发

克隆项目

git clone https://github.com/codebuddy/api-speed-tester.git
cd api-speed-tester

安装依赖

npm install

开发命令

# 开发模式运行
npm run dev

# 构建项目
npm run build

# 运行示例
npm run example

# 清理构建文件
npm run clean

项目结构

api-speed-tester/
├── src/
│   ├── api-speed-tester.ts  # 主要测试器类
│   ├── types.ts             # 类型定义
│   ├── index.ts             # 入口文件
│   └── example.ts           # 使用示例
├── dist/                    # 构建输出
├── package.json
├── tsconfig.json
├── README.md
└── LICENSE

🤝 贡献

欢迎提交 Issue 和 Pull Request！

1. Fork 本项目
2. 创建特性分支 (git checkout -b feature/amazing-feature)
3. 提交更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 开启 Pull Request

📄 许可证

本项目基于 MIT License 开源。

🙏 致谢

• Axios - 优秀的 HTTP 客户端库
• TypeScript - 强类型的 JavaScript 超集

📞 支持

如果你觉得这个项目有用，请给它一个 ⭐️！

如有问题或建议，请：

• 提交 Issue
• 发送邮件至 [email protected]