SuperAPI AI 工具集

configure-api-tests

编程与开发

查看项目

更新于 10-16 06:22

技能介绍

用途:检查并配置 API 契约测试基础设施,验证 API 契约、Schema 以及消费者与提供者之间的约定。适用于搭建 Pact 消费者/提供者契约测试、配置 OpenAPI 请求响应校验、添加 JSON Schema 或 Zod 模式测试、在 CI 中检测破坏性 API 变更、审计项目 API 测试合规性。单元测试、手动验证单个端点、查看覆盖率、代码审查与通用 CI 工作流应使用其他方案(如 /configure:tests、/configure:coverage、/configure:workflows)。

主要能力:检测现有测试基础设施(依赖中的 pact、openapi.yaml/swagger.json、ajv、pacts 目录等);分析契约测试、OpenAPI 校验、模式测试的完整性;生成格式化的合规报告;在 --fix 时按模板安装依赖并创建消费者/提供者测试文件、校验器与响应校验辅助、Zod 模式定义、破坏性变更检测;创建 .github/workflows/api-tests.yml,加入消费者契约测试、提供者验证、OpenAPI 规范校验与 PR 破坏性变更检测作业;更新 .project-standards.yaml。

使用方式与参数:/configure:api-tests 检查合规并提供修复;--check-only 仅报告不修改(CI/CD 模式);--fix 自动应用修复;--type <pact|openapi|schema> 聚焦某一类型。JavaScript/TypeScript 项目用 bun add --dev 安装,Python 用 uv add --group dev。Pact 文档 https://docs.pact.io,OpenAPI 规范 https://swagger.io/specification,Zod 文档 https://zod.dev。

适用场景:微服务与多消费者场景、API 优先开发、GraphQL 或单服务简单校验。

限制:具体模板见 REFERENCE.md,本次资料未提供其内容;资料未说明价格、平台与效果;错误处理包括未找到 OpenAPI 规范时提供创建模板、Pact 版本不匹配时建议升级、模式校验失败时报告具体错误、未配置 Pact Broker 时提供设置说明。除上述内容外,其他细节暂未提供。