将接口目录构建为持续维护的系统间契约及其负责人的清单。它把架构图连接到团队在实现、事件响应和变更规划中所需的细节。
从业务流程开始
走查一个真实流程，例如订单履约，列出每次 API 调用、事件、文件传输和定时数据交换。还应包括不太显眼的路径，例如对账导出和手动恢复导入。
为每个接口记录：
- 稳定标识符、业务用途、生产方、消费方和责任联系人。
- 方向、传输方式、端点或文件位置，以及版本化 schema 的链接。
- 数据归属、标识符、分类和访问机制，但不存储凭据。
- 时序或日程、预期数据量、载荷限制和商定的服务期望。
- 在适用时记录超时、重试、重复、排序和错误处理规则。
- 监控、升级处理、兼容性策略和停用依赖。