SuperAPI AI 工具集

api-tests

测试与质量

查看项目

更新于 10-15 23:49

技能介绍

用途:为项目检查并配置 API 契约测试基础设施,验证 API 契约、模式以及消费者与提供方之间的约定。命令为 /configure:api-tests。

适用场合:搭建 API 契约测试(Pact、OpenAPI、schema);校验 OpenAPI 规范合规性;为 CI 加入破坏性变更检测;检查 API 测试基础设施状态;配置 Pact 消费者/提供方工作流。不适用场合:运行已有 API 测试(直接用 bun test 或测试运行器);编辑 OpenAPI 规范内容(直接用编辑器);通用 CI 工作流搭建(用 /configure:workflows);单元或集成测试搭建;调试具体接口失败。

主要能力:检测项目中的 Pact、OpenAPI、Zod/AJV、swagger-parser、pacts/ 目录等指标;检查契约测试、OpenAPI 校验、模式测试的完备性;输出格式化合规报告;按 --type 聚焦 pact、openapi 或 schema;按 --fix 自动补齐依赖与模板;生成 .github/workflows/api-tests.yml;更新 .project-standards.yaml;输出最终变更报告。

用法:参数支持 --check-only(仅报告不改动)、--fix(自动修复)、--type <type>(pact、openapi 或 schema)。执行分步进行:检测基础设施、分析现状、生成报告、按确认应用配置、配置 CI/CD、更新标准跟踪、生成最终报告。示例:/configure:api-tests --check-only、/configure:api-tests --fix、/configure:api-tests --fix --type pact。

限制与错误处理:未找到 OpenAPI 规范时可提供模板;Pact 版本不匹配时建议升级路径;模式校验失败时报告具体错误;Pact Broker 未配置时提供设置说明。具体版本、价格与平台支持等资料暂未提供。