用途:对项目中的 API 端点做冒烟测试,确认所有接口返回健康响应。它把代码库分析与 HTTP 请求结合起来,先找出路由,再逐个请求并分类结果。
主要能力:
- 发现路由:支持 Next.js(App Router 的 app/api//route.ts、Pages Router 的 pages/api//*.ts)、Express(app.get、app.post、router.get 等)、Django(urls.py 中的 urlpatterns)、FastAPI(@app.get、@app.post 装饰器)、Rails(routes.rb),整理出端点及其 HTTP 方法列表。
- 确保服务器运行:检查终端文件是否有正在运行的开发服务器,没有则启动一个。
- 请求每个端点:使用 curl 检查状态码,例如 curl -s -o /dev/null -w "%{http_code}" -X <METHOD> http://localhost:<PORT><PATH>;对需要请求体的 POST/PUT/PATCH,发送最小合法 JSON,例如 curl -s -o /dev/null -w "%{http_code}" -X POST http://localhost:<PORT><PATH> -H "Content-Type: application/json" -d '{}'。
- 分类结果:200-299 为 OK;301/302 为重定向(OK);400 为错误请求(空 POST 体属预期);401/403 为需要认证(受保护路由属预期);404 为路由未找到(代码中存在但未提供,属 BUG);500 为服务器错误(BUG);000/超时为服务器无响应(BUG)。
- 报告:输出测试端点数、通过数、需认证数及错误列表,例如 500 — POST /api/webhooks/stripe(TypeError: Cannot read property 'id' of undefined)、404 — GET /api/v2/health(路由已定义但未挂载)。
- 修复错误:对 500 错误读取终端输出的堆栈跟踪并修复根因;对 404 检查路由文件位置与导出是否正确。
适用场景:本地开发或 CI 中快速验证 API 可用性,尤其适合在改动路由或中间件后做回归检查。
限制:资料未提供具体安装命令、依赖要求、支持的端口配置方式、认证凭据处理方式及是否支持并发或批量测试;实际使用需自行确保开发服务器可访问且端点无需真实业务数据。