核心原则
为什么 ApiHug 把契约视为受控的事实来源,用来保持代码、文档与协作的一致性。
单一可信源(SSOT,Single Source of Truth)指的是:团队明确约定哪一个受控对象代表“当前真实状态”。
在 API 场景里,问题不只是把信息保存下来,而是当需求变化时,如何让产品意图、接口定义、生成代码、测试和文档持续保持同步。
分工一旦变多,漂移就很容易发生:
如果每个角色读取的是不同来源,变更管理就会越来越慢,也越来越容易出错。
源码对“程序如何运行”当然是权威的,但它并不总是理想的协作介质。
源码本身通常无法同时满足两件事:
这也是为什么很多纯代码驱动的 API 工作流,即使能反向生成文档,仍然会逐渐失去同步。
受控的规范可以为团队提供一层中立的协作界面。
它不再把实现、文档、测试当成三套平行世界,而是把它们都收敛到同一份持续演进的契约上。API 生态里常见的形式包括 OpenAPI、gRPC、AsyncAPI、GraphQL 等。
ApiHug 把契约视为 API 生命周期中的协作中心。
这份契约应该:
这也是 ApiHug 为什么强调契约优先,而不是把文档生成或代码生成当成附属能力。
Git 很适合作为 SSOT 的承载层,因为它天然提供了:
它不会自动解决所有同步问题,但它提供了围绕契约变化建立自动化流程所需要的控制面。
当一个新接口被加入时,最先变化的应该是契约。随后,这个契约变化再驱动:
如果没有这条链路,团队通常就会退回到手工同步,并把“不同步”当成常态。
SSOT 不只是一个存储概念,它本质上是一套变更管理策略。ApiHug 通过把契约作为这套策略的核心,帮助团队减少理解偏差,更安全地自动化,并让 API 生命周期中的多类产物保持一致。