Apifox 接口导入助手
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3cf79a87/apifox-helper。
技能介绍
解决什么问题
把编辑器中选中的接口代码手动整理成 OpenAPI 文档,常常要补 method、path、parameters、requestBody 和 responses,还要决定导入 Apifox 的模块、目录和重复策略。Apifox Helper 面向这一流程:只处理用户选中的接口,不默认扫描项目,把选区代码转换为最小可用 OpenAPI 3 文档,并通过脚本导入指定项目。
如何工作
它先读取 config.json 中的 accessToken 与 projectId;如果缺失会先要求补齐,不带缺失配置执行。随后提取 HTTP 方法、路由路径、Header、路径参数、查询参数、请求体、成功响应结构和控制器标签。接口名称按注释、框架摘要注解、函数名加路由语义的优先级生成。生成文档时只补必要结构:summary、paths、parameters、requestBody 和至少一个最小响应,不凭空臆造复杂 schema。导入时使用 scripts/import_openapi.py 请求 Apifox OpenAPI 导入接口,默认优先通过标准输入传递 JSON,不额外落盘;必要时临时文件也放在当前项目目录。
适用边界
适合把单个接口、路由处理函数或控制器片段同步到 Apifox。若用户指定导入位置,可传 moduleId;targetEndpointFolderId 必须与 moduleId 一起使用,单独传入会被忽略。重复策略未指定时默认 OVERWRITE_EXISTING,也可映射 AUTO_MERGE、KEEP_EXISTING、CREATE_NEW。如果 HTTP 方法或路由路径不清晰,技能会先询问,不猜。
使用场景
- 选中一段 FastAPI 路由函数,希望生成最小 OpenAPI 并导入 Apifox 当前项目
- 查看一个 controller 方法,想把它同步到 Apifox 指定模块根目录
- 整理带 Header 鉴权参数的接口,导入时保留已有接口不覆盖
- 需要把无注释的 POST /orders 路由命名成创建订单并上传
适合人员
- 需要把单个 HTTP 接口从代码同步到 Apifox 的后端工程师
- 在接口评审前补全单个端点文档的 API 工程师
- 维护控制器或路由片段并更新接口资产的开发者
- 需要按模块或目录整理 Apifox 接口资产的团队协作成员