SuperAPI AI 工具集

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

编程与开发

查看项目

更新于 10-16 05:43

技能介绍

用途:这是一条重构与 API 设计原则,用于在引入新内部 API 时避免新旧接口长期并存。核心主张是:一旦确认新 API 是正确设计,就在同一波重构中迁移调用方并删除旧 API,而不是保留兼容层。

主要规则:不要仅因内部调用方仍存在就让旧 API 路径继续存活;应先盘点调用方、迁移它们,随后立即删除旧 API;临时适配器应被视为例外并限定时间,而非默认架构;更新测试以断言新契约,并删除只保护重构前实现细节的测试。

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

理由:同时保留新旧 API 会造成双路径复杂性,拖慢清理,使代码库呈现只增不减的状态。

限制:资料未提供具体安装命令、代码示例、工具集成方式或平台支持信息。