契约先行流程(跨团队接口)

适用场景:A 团队需要 B 团队提供一个还不存在的接口。

流程

1. 需求方在本目录提 PR:contracts/<提供方服务>/<接口名>.md(或 .yaml)
      内容:URL、方法、入参/出参字段(含中文说明)、错误码、调用场景
2. 提供方 + 需求方在 PR 里评审,达成一致后合并  ← 合并 = 契约生效
3. 提供方按契约实现;需求方可先按契约 mock 开发
4. 实现上线、EOLINK 文档同步后,把契约文件移入 contracts/_archived/

契约模板

markdown

# <接口名>
- **提供方**: hiapi-cloud-xxx   **需求方**: hiapi-cloud-yyy
- **URL**: POST /cloud-xxx/feign/resource/action
- **场景**: 为什么需要这个接口

## 入参
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mid | long | 是 | 商户ID |

## 出参
| 字段 | 类型 | 说明 |
|---|---|---|

## 错误码

已有接口的变更

不走本流程,但必须遵守API 设计约定的兼容性纪律:字段只加不删、改语义必须 @ 调用方团队。

Java 服务间调用同时更新提供方仓的 <svc>-contract,并让 /feign/** 的 controller implements 它——编译期契约比文档更硬。