返回提示词库
代码开发Claude工作流测试架构

API 契约测试计划

为前后端、服务间或开放 API 设计契约测试和兼容性检查。

API 契约测试计划

提示词正文

# 角色
你是一名测试架构师,擅长用契约测试降低跨团队集成风险。

# 使用场景
我需要为 API 改动设计测试,避免上线后前后端或客户集成断裂。

# 请先向我收集这些输入
1. API 描述、请求响应示例和错误码
2. 消费者列表和版本兼容要求
3. 计划变更内容和上线窗口
4. 现有测试框架和 CI 流程

# 任务
基于我提供的信息,完成「API 契约测试计划」。如果关键信息不足,请先提出最多 5 个澄清问题;如果信息足够,请直接输出结果。

# 输出结构
1. 契约范围:必须锁定和允许变化的字段
2. 消费者驱动测试用例
3. 兼容性矩阵和弃用策略
4. CI 接入、失败处理和发布门禁

# 质量标准
1. 覆盖成功、错误、空值、权限、限流和版本场景
2. 明确哪些变化是破坏性变更
3. 输出可以直接转成测试任务

# 避坑要求
1. 不要只测 happy path
2. 不要忽略老版本客户端
3. 不要把契约测试当端到端测试替代品

# 最后交付
请在末尾提供一个「可直接复制使用的精简版」,保留关键约束,去掉解释性文字。

编辑整理 · 最近更新 2026/07/09 · 适用模型 Claude

使用指南

如何使用这条提示词

这条模板适合处理代码开发任务。先把示例信息替换为你的真实条件,再交给 Claude 生成,结果会比直接复制示例更稳定。

  1. 第 1 步

    说明技术栈、运行环境、输入输出和现有约束。

  2. 第 2 步

    先让模型给出方案和风险,再生成最小可验证改动。

  3. 第 3 步

    在本地运行测试、类型检查和关键场景后再合并。

需要替换或补充的内容

以下信息越具体,生成结果越接近实际需求。不要提交隐私、账号密码或未公开商业数据。

  • 语言、框架与版本
  • 当前代码和报错信息
  • 期望输入与输出
  • 兼容性和性能约束
  • 验收测试场景

生成结果检查

  • 代码能否在指定版本运行
  • 边界情况和错误是否被处理
  • 是否复用了项目现有模式
  • 测试是否覆盖关键行为
  • 是否引入安全或性能风险

常见调整方法

答案偏离项目时,补充目录结构和相关接口定义。

改动过大时,要求限制文件范围并分步骤提交。

结果无法验证时,明确要求可运行的测试命令和预期输出。

这条提示词把代码开发、工作流、测试、架构相关要求拆成角色、上下文、限制条件和输出格式,便于模型逐项执行。调整时保留任务目标,只修改与你当前结果不符的条件,通常比整段重写更容易得到稳定结果。

相关提示词

继续浏览代码开发分类中的其他模板。