SuperAPI AI 工具集

principle-migrate-callers-then-delete-legacy-apis

编程与开发

查看项目

更新于 10-16 07:07

技能介绍

用途

这条原则用于指导内部 API 的重构决策。当团队已经确定某个新 API 是更合理的设计时,该原则主张在同一轮重构中完成调用方迁移并删除旧 API,而不是为了兼容仍然存在的内部调用方而保留旧路径。

主要能力

原则给出了几条明确规则:

  • 不要仅仅因为内部调用方仍然存在就保留旧 API 路径。
  • 盘点调用方,迁移它们,并立即删除旧 API。
  • 将临时适配器视为例外并设定时限,而不是默认架构。
  • 更新测试以断言新契约,并删除那些只保护重构前实现细节的测试。

使用方式

该原则以规则形式呈现,供在引入新内部 API 时对照执行:先确认适用条件,再按规则盘点调用方、迁移、删除旧 API,并同步调整测试。资料未提供具体的命令、代码示例或工具集成方式。

适用场景

原则明确列出适用条件:

  • 没有外部用户依赖向后兼容。
  • 项目能够承受协调一致的破坏性变更。
  • 新 API 属于简化或重构计划的一部分。

限制

资料指出,保留新旧两套 API 会带来双路径复杂性、拖慢清理,并使代码库呈现只增不减的状态。原则本身未提供其他限制说明,也未提供具体实施步骤或工具支持。