YAPI-Extractor

MCP文档知识

提供方 MatchaCutie

文档知识 未标注 无需鉴权 社区 / 第三方 Cline

YAPI接口文档提取器MCP服务器,可以从YAPI接口文档自动生成mock数据和TypeScript类型定义。

一句话选型结论

按资料字段整理

YAPI-Extractor 属于文档知识类 MCP 服务器,传输方式未标注,无需鉴权,可直接接入 Cline,没有现成安装命令,需按官方文档接入。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类文档知识 传输方式未标注 鉴权无需鉴权 部署方式未标注
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

文档知识
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

API文档JavaScript本地部署Mock数据生成TypeScript类型定义自动化工具开发辅助

安装与配置

未标注 无需鉴权
上游未给出传输方式
  1. 1
    准备运行环境

    按官方文档确认运行环境(常见为 Node.js 或 Python),装好后再执行安装命令。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
文档检索问答

在你的文档库里按问题找答案。

知识库读写

把新资料写进知识库,随用随取。

内容整理

把零散资料归纳成结构化笔记。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 已适配 Cline,换客户端不用重新研究配置。
  • 资料标注无需鉴权,装好就能连。

先想清楚的地方

  • 没有现成安装命令,需要按官方文档自己填启动命令和参数。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在文档知识场景里让模型直接调用外部能力的人。
  • 已经在用 Cline 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
YAPI-Extractor当前 未标注 未标注 未标注 无 2026-05-17
dify 未标注 stdio · 本地进程 本地部署 有 2026-04-11
open-webui 未标注 stdio · 本地进程 本地部署 有 2026-04-11
JeecgBoot 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Cherry Studio 未标注 未标注 未标注 无 2026-05-17
mempalace 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

文档知识
字段来自项目仓库与公开索引,中文说明由本站标注
提供方MatchaCutie上游标注的维护方 MatchaCutie
分类文档知识本站按上游分类展示
连接方式未标注上游未给出传输方式
鉴权方式无需鉴权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · 未标注本地安装时用到的包标识与运行时
部署类型未标注上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

4.2 KB
来自项目仓库与上游目录的原文,未做删改

YAPI Extractor MCP Server

YAPI接口文档提取器MCP服务器,可以从YAPI接口文档自动生成mock数据和TypeScript类型定义。

功能特性

  • 🔐 自动登录YAPI系统获取认证
  • 📋 解析YAPI接口的JSON Schema
  • 🎯 智能生成mock数据(支持YAPI mock语法)
  • 📝 自动生成TypeScript类型定义
  • 💾 支持自动保存文件到指定目录

安装```bash

npm install
npm run build


## 配置

在Cline的MCP配置文件中配置环境变量(通过env字段):

**必需的环境变量:**
- `YAPI_BASE_URL`: YAPI服务器地址
- `YAPI_EMAIL`: 登录邮箱
- `YAPI_PASSWORD`: 登录密码

**可选的环境变量:**
- `SAVE_FILES`: 是否自动保存文件 (`"true"` 或 `"false"`)
- `OUTPUT_DIR`: 文件保存目录路径

## 工具说明

### 1. extract_yapi_interface

从YAPI接口文档提取信息并生成mock数据和TypeScript类型定义。

**参数:**
- `interfaceId` (必需): YAPI接口ID
- `generateType` (可选): 生成类型,可选值:`mock`, `types`, `both`,默认 `both`
- `saveFiles` (可选): 是否保存生成的文件,默认 `false`

**示例:**```json
{
"interfaceId": "9769",
"generateType": "both",
"saveFiles": true
}

2. save_generated_files

保存生成的mock数据和类型定义文件到本地。

参数:
- interfaceId (必需): 接口ID,用于生成文件名前缀
- mockData (可选): mock JSON数据字符串
- typeDefinitions (可选): TypeScript类型定义字符串

示例:```json
{
"interfaceId": "9769",
"mockData": "{\"code\": 200, \"msg\": \"success\"}",
"typeDefinitions": "export interface Response { code: number; msg: string; }"
}


### 3. save_advanced_mock

保存高级mock数据到YAPI系统,支持创建多个mock场景。

**参数:**
- `interfaceId` (必需): YAPI接口ID
- `projectId` (必需): YAPI项目ID
- `name` (必需): mock场景名称,通常使用接口名称
- `mockData` (必需): mock数据的data部分(JSON字符串),不需要包含code和msg

**示例:**```json
{
"interfaceId": "9769",
"projectId": "63",
"name": "奖励弹窗",
"mockData": "{\"reward\": {\"type\": 1, \"amount\": 100}}"
}

MCP服务器配置

在Cline的MCP配置文件中添加:```json
{
"mcpServers": {
"yapi-extractor": {
"command": "node",
"args": ["/path/to/yapi-mock-server/build/index.js"],
"env": {
"YAPI_BASE_URL": "http://your-yapi-server:3000",
"YAPI_EMAIL": "your-email",
"YAPI_PASSWORD": "your-password",
"SAVE_FILES": "true",
"OUTPUT_DIR": "/path/to/output/mock"
}
}
}
}


## 使用流程

1. **启动MCP服务器**```bash
npm start
  1. 调用extract_yapi_interface工具
    - 传入YAPI接口ID
    - 指定生成类型(mock数据、类型定义或两者)
    - 可选择自动保存文件

  2. 处理返回结果
    - 服务器会自动登录YAPI
    - 解析接口的JSON Schema
    - 生成相应的mock数据和类型定义
    - 根据配置保存文件

输出文件格式

Mock数据文件

  • 文件名格式: {interfaceId}-mock.json
  • 内容: 完整的JSON响应示例

类型定义文件

  • 文件名格式: {interfaceId}-types.ts
  • 内容: TypeScript接口定义

支持的YAPI Mock语法

  • @timestamp: 生成当前时间戳
  • @pick([...]): 从数组中随机选择值
  • min,max: 生成指定范围内的数字

示例输出

对于ID为9769的"奖励弹窗"接口,会生成:

  • 9769-mock.json: 完整的奖励弹窗响应数据
  • 9769-types.ts: TypeScript类型定义

错误处理

服务器包含完善的错误处理机制:
- YAPI登录失败
- 接口不存在
- JSON Schema解析失败
- 文件保存失败

所有错误都会通过MCP协议返回详细的错误信息。

技术栈

  • 运行时: Node.js (ESM)
  • 语言: TypeScript
  • MCP SDK: @modelcontextprotocol/sdk
  • HTTP客户端: axios
  • 环境变量: dotenv

开发```bash

安装依赖

npm install

开发模式运行

npm run dev

构建项目

npm run build

清理构建产物

npm run clean


## 目录结构```
yapi-mock-server/
├── src/
│   └── index.ts        # MCP服务器主入口
├── build/              # 编译输出目录
├── mock/               # 默认mock文件输出目录
├── package.json
├── tsconfig.json
└── README.md

许可证

MIT

常见问题

6 问
答案由本站依据条目字段整理,不引用上游原文
YAPI-Extractor 怎么安装?

资料没有给出安装命令,请到官方仓库或文档按说明接入;这类条目多数是生态应用,或尚未发布可安装包。

YAPI-Extractor 怎么在 Cline 里配置?

它的传输方式未标注,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

YAPI-Extractor 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

YAPI-Extractor 需要 API Key 吗?

资料标注为无需认证,装好就能连;如果实际调用时报鉴权错误,按官方文档补上凭据。

YAPI-Extractor 支持哪些客户端?

资料标注支持 Cline;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

YAPI-Extractor 能提供哪些能力?

资料显示能力标签包括 API文档、开发工具、JavaScript、Cline。具体工具清单以官方文档为准。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。