跳到内容

工程

接口契约核对

在改字段、错误码或空态之前,先把调用方会不会被弄坏写清楚。

这是一份技能包:步骤、约束和可复制提示词。贴进 Cursor 或 Claude 之后,由你自己运行。

步骤

  1. 1

    列出调用关系

    写出这个接口的路径或函数名、请求与响应里这次要动的字段,以及你从材料里看到的调用方。材料没写调用方,就标成未知,不要猜一个。

  2. 2

    判断是不是破坏性变更

    删字段、改类型、改必填、改错误码含义、把空列表改成 null,都算可能破坏兼容。逐条说明旧调用方会看到什么。

  3. 3

    写出过渡办法

    能加字段就不要改旧字段。需要换含义时,写出旧字段保留多久、新字段叫什么、调用方要改哪一层。

  4. 4

    把空态和失败写进契约

    成功之外,写清无数据、无权限、校验失败分别返回什么。不要只给一个快乐路径的例子。

约束

  • 不根据没看到的代码假设「应该没有人用」。
  • 不把内部重构说成对外无影响,除非响应形状确实没变。
  • 不设计需要未授权访问生产数据才能完成的核对。

可复制提示词

```text
请遵守 engineering/engineering-backend-architect.md 的角色要求,并在影响界面时参考 engineering/engineering-frontend-developer.md。

按「接口契约核对」处理我提供的接口说明或 diff:
1. 列出这次改动的字段、类型和调用方。不知道的调用方写「未知」。
2. 标出破坏兼容的点,以及旧调用方会遇到的现象。
3. 给出保留旧字段或分阶段切换的建议。
4. 补上无数据、无权限、校验失败三种情况。

请用这四段输出:

会用到这项技能的任务模板