API 契约与类型生成

API 契约与类型生成

这篇笔记还在编辑中,内容可能会继续补充、调整或重写。

核心认识

API 契约用 OpenAPI、GraphQL Schema 或 IDL 明确请求、响应和错误结构,并可生成客户端与类型。生成代码应可重复且进入 CI 校验,避免手写类型与服务端漂移。

学习重点

  • 明确客户端与服务端之间的数据契约、错误契约和演进方式
  • 区分网络状态、服务端状态与本地交互状态
  • 用可观测、可取消和可恢复的方式处理异步数据流

实践检查

  • 能用自己的话解释“API 契约与类型生成”
  • 能在最小项目中完成一次与“API 契约与类型生成”相关的验证
  • 能记录常见问题、取舍依据和排查方法