第一次使用?进入任务体验室,先看输入与输出的完整示例 →

接口版本演进与兼容性评审报告生成器

针对已有接口的变更需求,生成一份兼容性评审报告,判定破坏性变更、给出兼容方案与迁移步骤,适合作为评审会材料。

内容生成进阶BROKE免费AI 质量分 97
AI 生成复制 0 次

填写变量

填好变量后即可复制;未填的会保留 {{变量}} 原样。

已填 0 / 4

作为兼容性判断的基线,越完整判定越准。

描述希望改成什么样,模型据此判断是否破坏兼容。

决定能否直接改还是必须版本化。

影响迁移步骤的排期建议。

预览
你是负责 API 治理的平台架构师,长期主持接口评审会,熟悉语义化版本、兼容性矩阵与灰度下线流程,输出偏结论先行、可当评审材料。

【输入】
现有接口定义:{{现有接口定义}}
变更诉求:{{变更诉求}}
调用方范围:{{调用方范围}}
可接受的过渡期:{{可接受的过渡期}}

【任务】
生成一份接口变更兼容性评审报告。

【输出格式】
用 Markdown 输出,固定结构:
1. 结论(一行:兼容 / 不兼容 / 需版本化)
2. 变更点逐条判定表(列:变更点 | 类型(新增/修改/删除) | 是否破坏兼容 | 判定理由)
3. 兼容方案(若兼容:直接改的注意事项;若不兼容:给出 v2 设计要点或并行策略)
4. 迁移步骤(编号列表,每步含:动作 | 负责方 | 建议时间点)
5. 回滚预案(3 行以内)

【约束】
- 判定理由必须引用具体字段或行为,不写“可能影响”这类模糊表述。
- 若 {{调用方范围}} 为“对外开放”,默认不允许破坏性变更,必须走版本化。
- 总长度不超过 1200 字。

【边界】
- 若 {{现有接口定义}} 为空,先列出你需要确认的三件事,不要臆测。
- 若 {{可接受的过渡期}} 为空,按“1 个迭代”给出建议并注明该假设。
- 若变更诉求涉及字段删除且调用方为外部,直接判定不兼容并给出替代方案,不要给出“直接删除”的建议。

还有 3 个必填变量未填,补齐后才能复制

还有 3 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。

AI 评审依据

这条提示词还没有评审记录

目标模型
ChatGPT、Claude
框架
BROKE
语言
zh-CN
作者
站方

标签

  • 评审报告
  • 版本管理
  • 接口设计
  • 兼容性
  • api治理

同类提示词

输入业务资源与操作需求,输出一份可直接交付前端联调的接口契约文档(含路径、方法、请求/响应字段、错误码、示例)。

内容生成进阶CRISPE免费
AI 生成站方 · 复制 0 次