API 反模式

常见反模式:隧道式单端点、把数据库表当资源、错误码全 200、无版本与无废弃策略、参数语义不一致;识别这些模式有助于在设计评审阶段提出改进项。

反模式

反模式症状改法
单端点隧道所有调用走一个 POST 路径按资源拆分接口
表驱动资源资源名与表名一一对应按领域语义建模
全员 200错误藏在响应体里用状态码与统一错误结构
静默变更字段语义变更无公告兼容策略与废弃流程
评审清单化:把反模式整理成检查项,接口设计评审按清单过一遍。

易错点

  • 历史接口无人敢改,新需求继续叠加特例
  • 评审只谈字段命名,忽略错误语义与兼容策略

数据来源与参考

  • Microsoft REST API Guidelines
  • 《Designing Web APIs》(Jin & Sahni)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌