Agent Skills
返回列表
YApi 接口管理命令行技能

YApi 接口管理命令行技能

开发编程 更新于 2026.08.30

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_59e19289/yapi-cli-skill

技能介绍

它解决什么问题

在 YApi 上维护接口时,开发者经常要在项目目录、接口文档、类型声明和 Mock 数据之间来回切换。想确认某个 POST /user/login 的入参,得先找到所属分类,再点进详情页;想让前端不被阻塞,还得手工复制一份类型定义。当这些操作需要在同一个 Agent 工作流里反复执行时,靠人肉在 Web 页面上点来点去会打断上下文,不同项目、不同环境的 baseURL 和 token 也容易混在一起。

这个技能做了什么

它只依赖 yapi CLI 本身,没有额外的常驻二进制,也没有 Python 包装层。所有命令共享同一套 TypeScript 核心,因此命令行的行为和 MCP 工具(yapi_search、yapi_get 等)保持一致,不存在两套实现。

核心能力按使用频率可以分成四类:

  • 检索:yapi search login --json 返回标题、路径、方法、所属项目与分类的匹配列表。
  • 取详情:yapi get /user/login -p 1437 --json 给出 method、path、query、body 和响应字段,加 --full 可拿到原始 schema。
  • 生成物:yapi types /user/login -p 1437 --name Login --json 产出可直接使用的 TypeScript 代码字符串,yapi mock /user/login -p 1437 --json 产出 mock 载荷。
  • 概览:yapi list -p 1437 --json 按分类树展示整个项目的接口布局。

典型工作流很短:先用 search 定位候选接口,再用 get 拿到单条接口的完整定义,只有前端需要契约或临时数据时才调用 types 或 mock。输出建议做摘要处理,不要把整段 JSON 原样粘贴回对话。

需要注意的边界

配置以 yapi.config.json 为准,宿主地址和 token 都写的在里面,activeProjectIds 相当于一个白名单。命令必须在能向上解析到该文件的工作目录里执行,否则 CLI 不知道该挂到哪个项目。多个项目同时处于 active 状态时,单项目命令必须显式传 -p,一律按 projectId 而不是项目名来定位。yapi 不在 PATH 上时,用 node /path/to/yapi-cli/dist/cli/index.js ... 的完整路径调用即可,行为完全一致。更多 flag 与配置结构见 references/workflow.md、references/config.md 和 yapi --help。

使用场景

  • 接手新 YApi 项目时,需要确认 POST /user/login 的路径、项目 ID 与所属分类,先用 yapi search 定位候选接口。
  • 前端联调前需要登录接口类型,对 /user/login 运行 yapi types 拿回已命名的代码片段。
  • 写测试用例前需要临时数据,用 yapi mock /user/login 生成贴合 schema 的 mock 载荷。
  • 盘点项目接口时,需要按分类了解整体布局,运行 yapi list -p 1437 获取分类树概览。

适合人员

  • YApi 项目后端开发者:想通过 CLI 快速检索接口并查看 method、path、query 和 body 的准确字段。
  • 前后端联调的前端工程师:需要在编码阶段拿到接口的 TypeScript 类型定义和 Mock 数据。
  • 维护接口文档的技术负责人:想通过分类树快速了解项目接口布局,减少网页逐页查找。
  • Agent 工作流集成者:希望用统一 CLI 让 AI 在项目上下文中搜索、读取和生成接口契约。