api-generator-cleanup.md
2.81 KB
API Generator 集成 - 清理记录
清理的旧文件
已删除
-
scripts/generateApiFromOpenAPI.js(18KB)- 原因:功能已整合到
.claude/custom_skills/api-generator/scripts/ - 替代:
.claude/custom_skills/api-generator/scripts/generateApiFromOpenAPI.cjs
- 原因:功能已整合到
-
.claude/custom_skills/api-diff/(空目录)- 原因:功能已整合到新的
api-generatorskill - 替代:
.claude/custom_skills/api-generator/
- 原因:功能已整合到新的
保留的文件
-
scripts/qiniu/- 七牛上传相关工具,保留 -
scripts/upload-to-qiniu.sh- 七牛上传脚本,保留
新的文件结构
mlaj/
├── scripts/ # 项目脚本
│ ├── qiniu/ # 七牛工具(保留)
│ └── upload-to-qiniu.sh # 七牛上传脚本(保留)
│
└── .claude/custom_skills/
└── api-generator/ # ✨ 新的统一 skill
├── skill.md # 完整文档
├── scripts/
│ ├── generateApiFromOpenAPI.cjs # API 生成
│ └── apiDiff.cjs # API 对比
├── templates/
│ └── api-specs-template.md # 文档模板
└── setup/
└── install.sh # 安装脚本
迁移说明
从旧结构到新结构
| 旧路径 | 新路径 | 说明 |
|---|---|---|
scripts/generateApiFromOpenAPI.js |
.claude/custom_skills/api-generator/scripts/generateApiFromOpenAPI.cjs |
改为 .cjs 扩展名 |
.claude/custom_skills/api-diff/ |
.claude/custom_skills/api-generator/ |
整合到统一 skill |
命令更新
// 旧命令(不再使用)
"api:generate": "node scripts/generateApiFromOpenAPI.js"
// 新命令(当前使用)
"api:generate": "node .claude/custom_skills/api-generator/scripts/generateApiFromOpenAPI.cjs"
清理原因
- 避免重复 - 功能已完全整合到新的 skill
- 统一管理 - 所有 API 生成相关文件集中在一个目录
- 更清晰的结构 - skill 自包含,便于跨项目复用
- 减少混淆 - 避免同时存在多个版本的脚本
测试验证
✅ 清理后功能正常:
# 生成 API 代码
yarn api:generate
# ✅ 正常工作
# 对比 API 变更
yarn api:diff docs/api-specs/example/ docs/api-specs/example/
# ✅ 正常工作
总结
成功清理了旧的重复文件,项目现在使用统一的 API Generator Skill,结构更清晰,功能更完整。