yapi

🔌 YApi 接口文档查询同步助手

🥥65总安装量 19评分人数 23
100% 的用户推荐

基于 YApi CLI 的接口文档智能查询与同步工具,帮助开发者快速获取 API 定义、实现本地文档自动化同步,提升前后端协作效率。

A

基本安全,请在特定环境下使用

  • 来自社区或个人来源,建议先隔离验证
  • ✅ 纯文档型资产,无代码执行风险,所有 CLI 操作均需用户手动执行确认
  • ✅ 无 eval/exec/system 等危险函数调用,无动态代码加载或静默数据收集行为
  • ⚠️ 来源为 T3 级个人开发者账号(leeguooooo),npm 包 `@leeguoo/yapi-mcp` 需用户手动安装并验证完整性
  • ⚠️ 需配置用户凭据(base_url, email, password/token)至本地配置文件 `~/.yapi/config.toml`,注意设置文件权限防止敏感信息泄露
  • ⚠️ 依赖外部 CLI 工具与 YApi 服务器通信,需确保连接的 YApi 实例(base_url)可信,避免在不可信网络环境传输接口定义数据

使用说明

该 Skill 专注于 YApi 接口文档的查询与同步管理。当用户粘贴 YApi URL 或提及相关需求时,系统会提取项目 ID 和接口 ID,通过调用 yapi CLI 工具与配置的 YApi 实例交互。支持通过 yapi search 按关键词搜索接口,使用 yapi --path /api/interface/get 获取详细定义(包含请求方法、路径、头信息、参数结构、响应模型及示例),并通过 yapi docs-sync 实现本地 Markdown 文档与 YApi 平台的自动化同步绑定。

显著优点方面,首先具备 URL 智能识别能力,可自动解析 YApi 链接中的项目与接口标识,无需手动输入 ID。其次,文档同步功能支持双向绑定,通过 .yapi/docs-sync.json 配置实现本地文档变更的自动检测与推送,支持强制全量同步与增量同步两种模式。第三,集成 Mermaid 图表渲染能力(依赖 mmdc),可将接口流程图自动转换为可视化图表。第四,纯命令行交互方式适合开发者工作流,查询结果可直接展示接口的 JSON Schema 定义与示例数据,便于快速理解数据结构。

潜在缺点与局限性不容忽视。该 Skill 存在明显的使用门槛,必须手动安装 @leeguoo/yapi-mcp npm 包并完成交互式登录配置,首次使用成本较高。其次,严格依赖特定 YApi 实例的配置,如果用户提供的 URL 与 ~/.yapi/config.toml 中配置的 base_url 不匹配则无法使用,灵活性受限。第三,文档同步功能对 Pandoc 有额外依赖(用于完整 Markdown 渲染),且 Mermaid 渲染失败不会阻塞同步但会影响文档完整性。第四,来源为个人开发者(T3 级),长期维护稳定性存疑。

适合的目标群体主要面向使用 YApi 作为 API 管理平台的开发团队,特别是需要频繁查询接口定义的前后端工程师;适合需要维护大量接口文档并期望实现本地文档与平台自动同步的 API 维护者;也适用于需要基于 YApi 链接快速获取技术细节进行代码编写或调试的技术人员。不适用于使用 Swagger、Postman 等其他 API 管理工具的团队。

使用风险方面,安全层面需特别关注凭据管理,YApi 登录信息(邮箱/密码或 Token)存储在 ~/.yapi/config.toml~/.yapi-mcp/auth-*.json 文件中,需确保文件权限设置正确防止泄露。依赖风险方面,核心功能依赖社区个人开发者维护的 npm 包,版本更新与安全补丁可能存在滞后。网络环境风险在于必须确保连接的 YApi 实例可信,避免在不可信网络环境下传输敏感接口定义。此外,CLI 工具执行需 Node.js 环境,若环境配置不当可能导致命令执行失败,且 Skill 本身无法自动处理安装与配置过程。

yapi 内容

手动下载zip · 1.9 kB
SKILL.mdtext/markdown
请选择文件