Agent Skills
返回列表
💻

httpYac 请求文件本地与 CI 检查

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/run-http-and-rest-request-files-with-variables-hooks-and-assertions-during-local-or-ci-checks-with-httpyac

技能介绍

解决的问题

在 API 开发与集成测试中,团队常依赖 Postman 等 GUI 客户端。然而,GUI 工具难以融入自动化流水线,手动验证接口既低效又易遗漏。GUI 生成的集合也常与仓库代码脱节,缺乏版本控制。核心痛点在于:如何在缺乏图形界面的 CI/CD 环境中,可靠、批量地执行并验证 API 请求?

核心能力与工作流

该技能基于 httpYac,将仓库内的 .http 和 .rest 文件作为接口测试的唯一事实来源。它支持 {{variable}} 语法定义变量,实现环境无缝切换。其工作流包含:

  • 请求执行:通过 CLI 解析请求文件并按序发送,摆脱 GUI 依赖。
  • 钩子机制:利用前置和后置钩子处理动态 token 生成或测试数据清理等复杂场景。
  • 断言校验:在文件中编写断言,自动校验状态码与 JSON 路径。断言失败时进程以非零码退出,直接阻断 CI 流水线。
  • 变量注入:支持通过环境变量或命令行参数动态注入配置。

适用边界与注意点

使用该技能需确保环境具备 Node.js 或 Docker 运行时,且网络可访问目标 API。.http 格式虽轻量,但处理复杂循环或条件分支时弱于代码级测试框架。断言编写需统一规范,避免用例因微小格式变动而脆弱失败。建议将其用于 API 冒烟测试与核心链路验证,而非替代深度业务逻辑集成测试。

使用场景

  • 在持续集成流水线中需要自动执行仓库里的 .http 接口文件,验证核心接口返回的状态码与数据是否符合预期。
  • 切换不同环境时,需要通过命令行运行带有变量的 .rest 文件,检查不同环境变量下的接口连通性与响应结果。
  • 编写接口冒烟测试时,需要使用前置钩子自动生成鉴权令牌,并在请求后添加断言校验响应体字段。

适合人员

  • 后端开发工程师,希望在不依赖图形界面工具的情况下,将接口冒烟测试无缝接入持续集成流水线。
  • 测试开发工程师,需要编写和维护包含动态变量与前置钩子的请求文件,以实现自动化接口校验。
  • 流水线维护者,负责在环境中批量执行请求文件,并依赖断言失败返回非零退出码来阻断不合格构建。