标签:API 契约

API 契约相关文章集合,覆盖接口 schema、错误码、版本兼容、契约评审和发布安全。

无 JS 回退页面 · 共 12 篇

按标签浏览(无 JS 兼容)

AI 生成客户端下的 API 变更治理

上个季度打到我 API 上的集成,有一半是那种从来没读过我文档的人写出来的。开发者在 Cursor 里敲一句含糊的提示词,Claude 或 Copilot 给什么就接什么,接完就上线。

阅读文章

AI 集成场景下的 API 错误分类体系

怎样设计一份 AI 生成的客户端真正用得上的 API 错误分类:稳定的 error code、机器可读的 category,以及区分可重试失败和永久失败的关键字段。

阅读文章

API Schema Diff 上线前评审实战

上线前如何做 API schema diff 评审:自动化 diff 工具能抓到什么、漏掉什么,以及 OpenAPI 和 GraphQL 仍然需要人工检查的那些点。

阅读文章

为 Agentic 客户端设计 API 规格

围绕「为 Agentic 客户端设计 API 规格」展开,说明契约字段、兼容边界、失败路径和评审检查点,帮助团队在上线前减少集成风险,可直接用于规格评审、实现前对齐和测试计划补充。

阅读文章

实时协作规格:冲突解决策略

围绕「实时协作规格:冲突解决策略」展开,说明规格边界、评审问题、示例写法和落地检查,帮助团队在实现前统一行为预期,可直接用于规格评审、实现前对齐和测试计划补充。

阅读文章

契约测试计划:从 OpenAPI 到 CI

围绕「契约测试计划:从 OpenAPI 到 CI」展开,说明契约字段、兼容边界、失败路径和评审检查点,帮助团队在上线前减少集成风险,可直接用于规格评审、实现前对齐和测试计划补充。

阅读文章

跨服务数据同步规格:一致性设计与取舍

我见过的每一份失败的跨服务同步规格都长得一个样:它把 happy path 写完就算交差。真正出事的地方,永远是作者没想到要写下来的那些——顺序、迟到事件、部分失败,以及上线第二天需要回填时到底要怎么办。

阅读文章

用规格设计幂等工作流

幂等性就是那种在规格里看起来只值一行字、一旦写错就能吞掉你一整周调试时间的特性。下面是我写"幂等性"章节的方式——让重试、崩溃、用户连点两下在生产环境里全都表现出同一种行为。

阅读文章

事件驱动系统的规格模式:契约与消费语义

事件驱动系统的规格范式:事件 schema 版本化、command 与 fact 事件的区分、choreography 与 orchestration 的取舍、幂等处理器,以及最终一致性边界的明确表达。

阅读文章

移动端离线模式 API 规格:同步与冲突解决

围绕「移动端离线模式 API 规格:同步与冲突解决」展开,说明契约字段、兼容边界、失败路径和评审检查点,帮助团队在上线前减少集成风险,可直接用于规格评审、实现前对齐和测试计划补充。

阅读文章

支付链路规格:失败场景与重试矩阵

我评审过的大多数支付规格,都用三页篇幅描写 happy path,再用一句话描写失败行为:“出错时重试”。生产环境里 80% 的事故,就是从这一句话里冒出来的。

阅读文章

Webhook 消费者规格:签名、重试与顺序

我评审过的绝大多数 webhook 消费端规格,覆盖的内容只有一个端点、几乎别无其他:URL、JSON 结构,再加一句含糊其辞的“校验签名”。那不是规格。

阅读文章