接口说明

1. 对外接口

对外接口文档用于给集成方和开发者阅读，重点回答：

• 能调什么
• 怎么调
• 需要什么鉴权
• 返回什么
• 失败时怎么处理
• 版本怎么兼容

2. 与内部设计文档的关系

• 面向开发者的人类说明放在本模块。
• 面向内部研发和架构的详细接口设计放在 API 设计文档。
• 机器契约文件和系统级接口约束放在 项目开发文档（内）/设计文档 下的契约目录。

3. 变更同步规则

接口发生以下变化时，必须同步更新：

1. 对外接口说明
2. 内部接口设计文档
3. 契约文件
4. 测试用例与发布说明