-
Stripe API 版本控制的运作方式,以及值得借鉴的做法
Stripe API 版本控制把每个账户固定在一个带日期的版本上,并允许单次请求覆盖它。本文讲这套机制如何运作、代价是什么,以及小型 API 可以借鉴哪些做法。
API 变更阅读约 1 分钟
-
Protobuf 破坏性变更:线上格式到底能保住什么
Protobuf 的破坏性变更发生在线上传输的字节流里,而不是 URL 路径。有些字段改动安全免费,有些会悄悄破坏所有老客户端,在代码 diff 里却几乎一样。
API 变更阅读约 1 分钟
-
GraphQL 模式变更:没有版本号的停用
GraphQL 的 URL 里没有 v1 或 v2,字段通过指令在同一份共享模式上逐个停用。本文说明这会如何改变体验日志要给调用方交代的内容。
API 变更阅读约 1 分钟
-
该怎样写一份真正管用的 API 迁移指南
API 迁移指南把一次不兼容的变更变成一份清单,而不是一次故障。本文说明它该写什么、何时发布、谁来写,以及为什么光靠一条体验日志记录不够。
API 变更阅读约 1 分钟
-
对内 API 体验日志:对另一个团队来说,到底什么变了
对外的 API 体验日志面对无法联系的读者,对内的读者可能就在两层楼之外,这改变了它的责任。本文讲这些差别、谁来维护调用方名单,以及和 monorepo 的关系。
API 变更阅读约 1 分钟
-
API 的 Sunset 响应头:什么时候该发送它
API 的 Sunset 响应头告诉客户端一个版本何时彻底停止应答,这和只说将来会停用的通知是两回事。本文讲 RFC 8594 的规定、这个响应头能否信任,以及提前限时停机。
API 变更阅读约 1 分钟
-
Webhook 体验日志:没人要求过的破坏性变更
Webhook payload 的改动会悄无声息地出问题,因为没人能拒绝它,接收方可能带着错误值运行好几天。本文讲什么样的改动算破坏性变更,以及如何加版本并安全迁移。
API 变更阅读约 1 分钟
-
API 体验日志: 该公开什么内容,又是谁在读它
API 体验日志的读者,是要判断自己的代码下个月还能否正常运行的人。本文说明每条记录应该交代什么、放在哪里,以及调用方如何订阅。
API 变更阅读约 1 分钟
-
面向调用方设计的 API 版本控制最佳实践
只对真正破坏兼容性的内容做版本管理,把版本号放在调用方看得见的地方,让旧版本运行到明确的截止日期。本文比较四种常见方案,并以对调用方的要求高低为标准。
API 变更阅读约 1 分钟