API 契约(API Contract)

一份对 API 的正式规范(OpenAPI、gRPC proto、GraphQL schema),生产方与消费方都同意遵守。

什么是 API 契约(API Contract)?

API 契约把一个接口从口口相传的经验变成受版本管理的产物。它支持客户端代码生成、CI 中的兼容性检查以及消费者驱动的契约测试。对于跨团队协作而言,它是架构所能拥有的最具杠杆作用的文档之一。

相关术语

  • 事件通道(Event Channel) — 一条具名、带类型的事件流(通常是 Kafka 主题或等价物),服务通过它进行异步发布与订阅。
  • 微服务(Microservices) — 一种架构风格,将应用构造为一组围绕业务能力组织、可独立部署的小型服务。

了解更多