Good APIs Age Slowly
8 days ago
- #System Boundaries
- #API Design
- #Software Maintenance
- 最初令人印象深刻的 API 往往会导致后续维护困难;应信任持久性而非初始的优雅。
- API 的第一个版本常被高估,因为它在真实世界依赖关系出现前,只会在简单环境中被评判。
- 关键的 API 设计问题涉及边界:尽早决定什么是公开的、什么是私有的,以避免意外的依赖。
- 初始时尽可能少地暴露,因为以后添加比在他人依赖后移除更容易。
- API 的便利性可能隐藏假设,导致面对新用例时僵化;无聊、诚实的 API 往往更持久。
- 避免围绕当前前端形态设计 API,以防止耦合到临时的 UI 决策。
- 版本控制并不能为糟糕的 API 设计开脱;稳定的 API 能建立信任并减少协调成本。
- 好的 API 会谨慎对待暴露的内容,尤其是在响应中,以防止意外的依赖。