综合介绍
api-check 是一个纯前端的 API 测试工具,由开发者 october-coder 在 GitHub 上开源。它主要用于测试 API 接口的可用性,尤其支持 OpenAI 的代理 API,比如 oneapi 和 newapi。所有操作都在浏览器中完成,不依赖后端服务器,确保数据安全,同时避免网络超时问题。工具提供响应时间、模型一致性等详细数据,还支持云端和本地存储测试配置。api-check 操作简单,支持中英文界面和深浅色模式,适合开发者快速验证 API 性能。它可以通过 Vercel、Docker 或 Cloudflare 部署,灵活性高。
功能列表
- 测试 OpenAI 代理 API 的可用性,比如 oneapi 和 newapi。
- 显示 API 响应时间、模型一致性和系统指纹,结果清晰可见。
- 支持云端存储,保存测试配置到服务器,实现多设备同步。
- 支持本地存储,缓存配置到浏览器,方便快速加载。
- 提供深色和浅色模式切换,适应不同使用环境。
- 支持中文和英文界面,满足不同用户需求。
- 集成快速聊天测试,验证模型响应能力。
- 支持批量测试 GPT、Claude 和 Gemini 的密钥。
- 提供一键复制功能,方便分享测试结果。
- 支持 Vercel、Docker 和 Cloudflare 多种部署方式。
使用帮助
安装与部署
api-check 是纯前端工具,可以直接使用在线版本,也可以自己部署。以下是三种部署方式的详细步骤:
Vercel 部署
- 访问 GitHub 仓库
打开https://github.com/october-coder/api-check
,进入项目页面。 - 一键部署
点击页面上的 "Deploy with Vercel" 按钮,或者直接访问https://vercel.com/new/clone?repository-url=https://github.com/october-coder/api-check
。 - 登录并配置
用 GitHub 账号登录 Vercel,在环境变量页面添加后端密码,例如:- 键:
PASSWORD
,值:your_password
。
- 键:
- 完成部署
点击 "Deploy",几分钟后会生成一个地址,比如https://api-check-yourname.vercel.app
。 - 可选操作
如果需要绑定自定义域名,可参考https://vercel.com/docs/concepts/projects/domains/add-a-domain
,避免默认域名在某些地区受限。
Docker 部署
- 运行命令
在终端输入以下命令,一键部署:
docker run -d -p 13000:13000 -e PASSWORD=your_password -v your_path:/app/data --name api-check ghcr.io/rickcert/api-check:latest
- 参数说明
-p 13000:13000
:映射端口到本地 13000。-e PASSWORD
:设置访问密码。-v your_path:/app/data
:指定本地存储路径。
- 访问工具
部署完成后,打开浏览器,输入http://localhost:13000
。
Cloudflare 部署
- 参考教程
访问https://github.com/october-coder/api-check/blob/main/docs/cloudflare.md
,按照步骤操作。 - 绑定域名
建议绑定自定义域名,确保访问稳定。
如何使用主要功能
测试 API 可用性
- 打开 api-check 页面(在线版
https://check.crond.dev
或自部署地址)。 - 输入测试参数:
- API Key:填入密钥,例如
sk-xxxx
。 - URL:输入 API 地址,例如
https://api.example.com
。 - 模型:选择模型,例如
gpt-4o-mini
。 - 超时时间:设置请求超时,例如
10
秒。 - 并发数:设置同时请求数,例如
2
。
- 点击 "Test" 按钮,等待结果。界面会显示:
- 响应时间(毫秒)。
- 模型一致性(是否与预期匹配)。
- 系统指纹(验证 API 真实性)。
保存和加载配置
- 云端存储:点击 "Save to Cloud",输入账号和密码,配置会上传到服务器。下次使用时,点击 "Load from Cloud" 加载。
- 本地存储:点击 "Save Locally",配置保存到浏览器。下次打开页面自动加载。
快速聊天测试
- 在界面找到 "Quick Chat" 选项。
- 输入测试问题,例如 "1+1等于几?"。
- 点击发送,查看模型返回结果,验证响应速度和准确性。
- 可通过
closeChat: true
关闭此功能(适合代理站点)。
批量测试密钥
- 进入 "Experimental Features" 模块。
- 输入多个密钥,例如 GPT Refresh Tokens 或 Claude Session Keys。
- 点击 "Batch Test",工具会逐一验证并显示结果。
高级验证功能
- 官方代理验证:发送多次相同请求,分析一致性并显示系统指纹。
- 温度验证:设置温度参数为
0.01
,测试模型随机性和稳定性。 - 函数调用验证:测试模型是否支持函数调用,返回结果是否正确。
操作流程举例
假设你要测试一个 OpenAI 代理 API:
- 打开
https://check.crond.dev
。 - 输入:
- API Key:
sk-test123
。 - URL:
https://api.test.com
。 - 模型:
gpt-4o
。 - 超时:
10
秒,并发:2
。
- 点击 "Test",结果显示响应时间 300 毫秒,模型一致性通过。
- 点击 "Save to Cloud",输入账号保存。
- 下次打开,点击 "Load from Cloud",配置自动加载。
- 进入 "Quick Chat",输入 "今天天气如何?",查看返回结果。
这个流程简单明了,适合快速上手。
应用场景
- API 性能验证
开发者需要检查 API 是否稳定。api-check 显示响应时间和一致性,帮助定位问题。 - 多设备配置同步
团队在不同设备上测试 API。用云端存储保存配置,成员可随时加载,提高效率。 - 学习模型行为
新手想了解 API 返回结果的规律。通过快速聊天和温度验证,观察模型表现。
QA
- api-check 需要后端支持吗?
不需要。它完全在前端运行,数据不上传第三方服务器。 - 支持哪些模型?
主要支持 OpenAI 代理 API 的模型,如gpt-4o-mini
,也兼容其他类似格式的 API。 - 如何查看测试报告?
测试完成后,界面会生成报告,包含响应时间、一致性和指纹等信息。