「接口契约测试」是开发与测试工程师的高频任务。它的输入通常是OpenAPI 文档,期望得到的是契约测试用例。这类有固定流程、又需要一点判断力的工作,很适合封装成智能体 Skill。

本文介绍如何在 n8n AI Agent 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。

这个技能做什么

项目说明
技能接口契约测试(api-contract-test)
作用根据 OpenAPI 文档生成接口契约测试
输入OpenAPI 文档
输出契约测试用例
形态带脚本
风险低
适用人群开发与测试工程师

处理流程分四步:

  1. 解析接口定义
  2. 为每个接口生成请求样例
  3. 断言状态码与结构
  4. 覆盖错误响应

这个技能需要运行本地脚本(解析文件、调用命令行工具等),要求运行环境允许执行代码;风险较低,但输出仍需快速过目再使用。

在 n8n AI Agent 中是什么形态

n8n 是可自托管的工作流自动化工具,内置 AI Agent 节点,可以给智能体挂上 HTTP 请求、代码等工具,并与数百种应用的触发器和动作衔接。

可以自托管或使用云服务;凭据在 n8n 中单独管理,不要写进节点参数。

示例配置

# n8n 流程示意(节点名称以 n8n 当前版本为准)
[Chat Trigger 或 Webhook]
      │ content
      ▼
[AI Agent]  系统消息:接口契约测试,解析接口定义;为每个接口生成请求样例;断言状态码与结构;覆盖错误响应
      ├─ 工具:Code(解析与校验)
      ▼
[IF 需人工确认?] ──是──▶ [发送给负责人审核]
      │否
      ▼
[输出:契约测试用例]

示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发与测试工程师提出相关请求时能对上号;二是约束部分要写进「生成的测试要先在本地跑通,别只盯覆盖率数字」这类领域规矩,避免智能体自作主张。

安装与启用步骤

  1. 新建工作流,选择聊天触发或 Webhook 触发
  2. 添加 AI Agent 节点,写系统消息
  3. 为 Agent 挂上需要的工具节点
  4. 加 IF 节点把需人工确认的结果转给负责人
  5. 测试后启用工作流

实操:一次完整的运行

假设你在测试框架与 CI 流水线中发出这样的请求(虚构示例):

用接口契约测试技能处理这份OpenAPI 文档,输出契约测试用例。

智能体识别到任务与「接口契约测试」相关后,会依次解析接口定义、为每个接口生成请求样例、断言状态码与结构、覆盖错误响应。最终交付契约测试用例,并在末尾列出需要人工确认的内容。你的工作是对照原始OpenAPI 文档抽查两三处关键信息,确认无误后再使用。

测试与验收

用固定测试数据手动执行工作流,检查每个节点输出,再开启自动触发。

针对这个技能,还建议额外准备:

  • 一份信息齐全的标准OpenAPI 文档,检查输出是否完整
  • 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
  • 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效

常见坑

  • 把密钥直接写进代码节点。
  • 自动触发未加频率限制,导致重复执行。
  • 只写了步骤,没写交付格式,导致每次输出的契约测试用例结构不同。
  • 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。

延伸阅读

说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。