SuperAPI AI 工具集

qe-contract-testing

测试与质量

查看项目

更新于 10-16 08:07

技能介绍

用途:指导使用 v3 的契约测试能力,包括消费者驱动契约、Schema 校验、向后兼容性检查与 API 版本验证。适用于测试 API 契约、校验 Schema 变更、检查向后兼容性、测试 GraphQL API 以及验证事件 Schema。

主要能力:

  1. 消费者驱动契约(Pact):指定 consumer、provider、契约文件与 provider 验证配置。
  2. Schema 校验:支持 openapi 等类型,可校验请求体、响应体、请求头与状态码。
  3. GraphQL 契约测试:校验查询有效性、响应结构、可空性与弃用项。
  4. 事件契约测试:按事件 Schema 与示例校验,支持 backward 兼容模式。
  5. 破坏性变更检测:区分必然破坏(如端点移除、新增必填参数、响应字段移除、类型变更)、可能破坏(如移除可选参数、新增响应字段、移除枚举值)与非破坏变更。
  6. 契约报告:汇总契约数、通过/失败/警告数、各消费者兼容性、破坏性变更与弃用信息。
  7. Pact Broker 集成:支持发布、canIDeploy 检查与 webhook。
  8. CI/CD 集成:消费者侧生成并发布契约、can_i_deploy 检查;提供方侧拉取契约、验证并发布结果;发布前检查破坏性变更。

必要用法(命令保持原样): aqe contract generate --api openapi.yaml --output contracts/ aqe contract verify --provider http://localhost:3000 --contracts contracts/ aqe contract breaking --old api-v1.yaml --new api-v2.yaml aqe contract graphql --schema schema.graphql --operations queries/

协调:主要智能体为 qe-api-contract、qe-api-compatibility、qe-graphql-tester,协调者为 qe-contract-coordinator,相关技能为 qe-test-generation、qe-security-compliance。

限制:资料未提供具体安装方式、收费与价格、平台支持范围及实际效果数据,暂未提供。