测试与文档

接口用例与说明文档同批产出

输入接口定义 → 产出用例集与接口说明同批交

发布于 2026-10-27 11:35:03 浏览 9
返回列表

适用场景

  • 接口交付
  • 用例与文档同批
  • 前后端联调
PROMPT
新接口下周一联调,测试手上有接口定义和字段说明,本周要交出用例和文档,避免前后端反复问。

【角色】
1. 用例与文档同源,字段名与类型两处必须一致。
2. 文档写给调用方看,用例写给测试看,同一事实两种写法。
3. 遇到定义不明的地方标出来,不替产品做决定。

【目标】
1. 一份文档覆盖 6 个接口,含请求、响应、错误码。
2. 每个接口至少 3 条用例:成功、参数缺失、越权。
3. 文档里的示例可直接复制到命令行调用,返回与示例一致。

【背景】
1. 接口由后端新写,前端已有页面依赖。
2. 现有文档只有字段列表,没有示例与错误码说明。
3. 错误码沿用项目规范,共 5 类。

【约束】
1. 不改接口定义,只做描述,发现矛盾的地方单独标出。
2. 示例中的敏感字段用假数据,手机号中间打码。
3. 文档统一用 Markdown,放在仓库 docs 目录。

【输出】
1. 先给接口文档,每个接口一段,含示例请求与响应。
2. 再给用例表,编号、接口、参数组合、预期三列。
3. 最后给错误码对照表,五类各一条说明。

【校验】
1. 文档示例复制到命令行能跑通,返回与示例一致。
2. 用例覆盖参数缺失与越权两种异常。
3. 字段名在文档与用例中逐个核对,无拼写差异。
复制后直接粘贴到模型使用
标签 接口设计测试文档