SuperAPI AI 工具集

piu-backend-sync

编程与开发

查看项目

更新于 10-15 21:09

技能介绍

用途:分析后端仓库,发现 API 路由,并通过 MCP 将其导入 PIU,生成项目、集合、请求和环境等实体;通过记录 git commit SHA 支持增量重同步。

主要能力:内置 CLI 脚本 bun scripts/piu.ts(MCP 客户端,46 个工具)与 bun scripts/detect.ts /path/to/repo(框架检测,输出 JSON)。支持框架包括 Hyperf、Laravel、Express、Fastify、NestJS、Hono、FastAPI、Django、Flask、Gin、Echo、Fiber、Axum、Actix、Rails、Spring。可按框架模式提取 HTTP 方法、URL 路径、处理器名与分组前缀,并批量创建项目、环境、集合、请求,从控制器 schema 提取模型并关联请求,生成请求的 markdown 文档。

使用方式:先做重同步检测(bun scripts/piu.ts list-projects、bun scripts/piu.ts diff-sync PROJECT_ID /path/to/repo),按 up_to_date、仅提交变更、路由文件变更或首次导入分别处理;随后克隆仓库并检测框架,git -C "$REPO" rev-parse HEAD 获取提交;再依次创建项目与环境(create-project、create-env)、批量集合(batch-collections)、批量请求(batch-requests)、环境变量(set-vars、activate-env)、批量模型与链接(batch-models、batch-links)、请求描述(batch-update-bodies);最后用 overview、tree、verify、model-mermaid、sync-status、changelog、search、api-surface 验证并清理临时目录后输出汇总。

适用场景:需要把后端代码中的路由快速映射为可调试、可文档化的 API 测试集合,并在代码变更后增量更新。

限制:verify 执行 GET 端点需后端运行且环境已激活;重同步前应先 search 避免重复;每个实体应设置 source_commit_id;monorepo 需先确认导入哪个服务;优先读取路由定义而非可能过时的 OpenAPI/Swagger 规范。其余信息暂未提供。