用途:在 UI 与服务之间设计或变更 REST、GraphQL、事件契约时,先定义契约再实现,减少集成错误并保持向后兼容;当需要做向后兼容或版本化决策时使用。
主要能力与工作流:捕获消费者需求与边界情况;起草契约 schema 与示例;定义版本化与兼容性保证;实现提供方与消费方校验;必要时带弃用时间线发布。
必要检查:显式列出必填与可选字段;定义错误信封与状态映射;发布成功与失败路径示例;避免无迁移路径的破坏性变更;契约测试在 CI 中运行;现有消费者保持兼容;弃用需记录并公告。
决策框架:在提供方或消费方代码合并前起草 OpenAPI、GraphQL 或事件 schema;将每个字段变更归类为安全新增、破坏性或带时间线的弃用;每次发布 schema 修订都必须在 CI 中运行消费者驱动的契约测试;多代消费者共存时对端点做版本化或使用兼容性头。
常见借口与反驳:先发布再补文档会导致契约漂移、消费者嵌入假设并静默失效;即使拥有全部客户端,移动端、合作方与异步消费者也会滞后部署,应假定存在外部消费者;代码注释中的示例无法被 CI 校验,应发布机器可读的 schema 与示例。
证据包:带与上一版本 diff 的已发布 schema 产物;消费者契约测试结果(提供方与消费方套件);破坏性变更的弃用时间线与迁移指南;校验、认证与未找到路径的错误信封示例。
退出标准:工作流决策已记录且可实施;存在质量、可靠性与兼容性的验证证据;运维就绪与回滚预期明确。
限制:资料未提供具体安装命令、代码示例、收费或平台信息。