YAPI 接口方法生成
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3782c7dd/write-api。
技能介绍
解决什么问题
YAPI 项目里的接口动辄几十上百个,前端拿到接口文档后,还要手动把每个接口翻译成 src/api/ 下的方法:抄路径、拼参数类型、对齐请求方式,再按项目现有风格调整命名和格式。这类工作本身没有难度,但重复、琐碎,还容易漏掉参数校验或类型定义。
write-api 把这一步交给工具完成:用一句话描述接口(如"截图队列接口")或直接给一个 YAPI ID,它负责搜索接口、读取详情、找到该写入的 API 文件,最后生成风格一致的请求方法。
核心流程
1. 解析意图:输入含纯数字或明确提及 ID,直接进入详情获取;自然语言描述则提取关键词进入搜索流程。
2. 搜索与定位接口:关键词含中文会先做 URL 编码再调用 YAPI。结果唯一时直接使用,多条时列出编号供选择(可多选,逗号分隔),无结果则提示换词重试。
3. 选择目标文件:按优先级逐级判断——你指定的路径 > 当前打开的 API 文件(内容含 request/axios 引入)> 扫描 src/api/ 与 src/services/ 下的候选文件 > 兜底让你指定路径。
4. 生成并插入代码:先分析目标文件的缩进、引号、分号、命名和导入风格,再按接口详情生成方法:
- 方法名由请求方式 + 路径生成驼峰(
GET /user/list→getUserList) - GET 参数逐一列为函数参数,通过
params传递 - POST/PUT 参数从 JSON Schema 解析,生成内联类型而非
Record - 路径参数用模板字符串 `
/api/user/${id}` - 注释固定使用 JSDoc:首行为接口标题,参数逐行
@param并标注必填/可选,末行为@see链接
生成前会检查文件中是否已存在同路径的方法,避免重复写入。
注意点
- 文件风格只作用于代码部分,注释不跟随项目风格,一律使用 JSDoc。
- 所有 YAPI 请求头中
ShortName固定传当前操作系统用户名,用于 YAPI 侧统计。 - 多条搜索结果、候选文件等需要确认的环节,会停下来等待用户输入。
- 类型定义、代码生成模板和响应结构的完整细节依赖随附的
reference.md。
使用场景
- 接手新项目,要把 YAPI 里的一批接口补进 src/api/ 目录
- 面对长截图队列接口,想让 AI 按现有风格生成调用方法
- 看到报错提示里的 YAPI ID,需要快速找到对应接口代码
- 在订单查询接口文档页,希望直接把方法写进当前 API 文件
适合人员
- 前端工程师:批量把 YAPI 接口转成项目内统一的请求方法
- Node.js 开发者:维护 src/services/ 下的接口层,减少手工抄写
- 技术负责人:统一团队的接口命名、注释和类型风格
- 编写 AI 辅助编程教程的作者:演示接口搜索到代码插入的完整链路