跳到主内容
博客 工程

API 设计的五个原则

REST 还是 RPC?版本怎么管?错误怎么报?一套经过验证的实践清单。

7 分钟阅读 143 次浏览
API 设计的五个原则

好的 API 设计让调用者「猜对」。

五个原则

  1. 资源命名用名词,不用动词
  2. 版本放在路径里,不在 header 里
  3. 错误返回统一结构:code + message
  4. 分页用 cursor,不用 offset
  5. 缓存头要显式
雄

雄哥

独立开发者 · 长期写作者

关于