跳到主要内容

接口改动 Brief 模板

适用场景:contract 已经清楚,准备进入接口实现、错误模型更新和验证阶段。

任务:实现一个后端接口改动
接口路径:
HTTP 方法:
请求 schema:
响应 schema:
错误码与状态码:
鉴权与租户边界:
需要兼容的旧客户端行为:
允许修改的文件:
必须补的验证:
- lint
- type-check
- contract test
- integration test
- smoke path
输出要求:
- 代码改动
- contract 或 schema 更新
- 风险说明
- 验证结果

最容易漏的字段

字段漏掉会怎样
兼容旧客户端行为容易把后端改动写成破坏式升级
错误码与状态码reviewer 很难判断 contract 是否完整
允许修改的文件实施时容易顺手扩散到无关目录

配套页面