YApi接口文档查询

技能简介

YApi接口文档查询技能用于连接YApi平台，支持查询接口定义、获取请求/响应详情，以及将本地文档与YApi分类进行绑定同步。适用于需要快速查看接口规范或保持文档一致性的开发场景。

能做什么

• 根据URL自动识别YApi项目ID和接口ID
• 查询单个接口的完整定义（方法、路径、参数、响应结构）
• 按关键词搜索接口列表
• 列出指定分类下的全部接口
• 将本地Markdown文档同步到YApi指定分类
• 生成接口文档的Mermaid图表渲染

使用说明

1. 安装CLI工具

npm install -g @leeguoo/yapi-mcp
# 或
pnpm add -g @leeguoo/yapi-mcp

2. 登录配置

yapi login

按提示输入YApi地址、邮箱和密码，配置保存至~/.yapi/config.toml。

3. 验证安装与登录

yapi --version
yapi whoami

4. 查询接口

# 通过ID获取接口详情
yapi --path /api/interface/get --query id=123

# 搜索接口
yapi search --q 用户登录

# 列出分类下接口
yapi --path /api/interface/list_cat --query catid=456

5. 文档同步（可选）

# 绑定本地目录到YApi分类
yapi docs-sync bind add --name my-docs --dir ./docs --project-id 1 --catid 10

# 执行同步
yapi docs-sync --binding my-docs

输入与输出

见下方输入与输出表格。

风险提示

• 需提前配置YApi账号权限，部分企业内网实例可能无法访问
• 文档同步会覆盖YApi端内容，建议先备份重要接口定义
• Mermaid渲染依赖mmdc，Pandoc需手动安装，缺失时不影响核心功能
• 接口创建时req_body_type和res_body为空可能导致添加失败

来源信息

原始链接：https://github.com/openclaw/skills/tree/main/skills/leeguooooo/yapi/SKILL.md
来源类型：GitHub仓库