项目说明

本项目基于 Node.js 开发，要求 Node.js 版本为 20.0 或更高。

使用方法

1. 确保已安装 Node.js (>=20.0)。
2. 克隆项目到本地。
3. 安装依赖：npm install。
4. 根据需求运行相关脚本或命令。

注意事项

• 请确保 Node.js 版本符合要求，否则可能导致运行异常。
• 如有问题，请提交 Issue 或联系维护者。

YAPI 备份与恢复工具

简介

本工具是一个基于 TypeScript 的 YAPI 数据备份与恢复工具，支持通过命令行或 MCP 协议进行操作。它提供了备份 YAPI 接口数据到本地以及从本地恢复数据到 YAPI 的功能。

功能

1. 备份工具

   • 将指定项目的接口数据备份到本地。
   • 工具名称：backupTool
   • 输入参数：
     • projectId (字符串): 需要备份的项目 ID。

2. 恢复工具

   • 将本地备份的接口数据恢复到指定的 YAPI 项目。
   • 工具名称：recoveryTool
   • 输入参数：
     • projectId (字符串): 数据恢复到的目标项目 ID。
     • interfaceJsonPath (字符串): 接口 JSON 文件路径。
     • detailJsonPath (字符串): 详细接口 JSON 文件路径。

使用方法

环境要求

• Node.js 版本 >= 20.0

安装依赖

npm install

运行工具

备份数据

运行以下命令备份指定项目的接口数据：

node ./index.js --token=<你的cookie> --domain=<你的域名> --outputDir=<输出目录> backupTool --projectId=<项目ID>

恢复数据

运行以下命令将本地备份的数据恢复到指定项目：

node ./index.js --token=<你的cookie> --domain=<你的域名> --outputDir=<输出目录> recoveryTool --projectId=<项目ID> --interfaceJsonPath=<接口JSON路径> --detailJsonPath=<详细接口JSON路径>

注意事项

1. 确保提供的 cookie 和 domain 参数正确。
2. 输出目录 (outputDir) 必须存在，且具有写入权限。
3. 恢复数据时，请确保 JSON 文件路径正确无误。

开发

本地开发

安装依赖：

npm install

启动开发模式：

npm run watch

构建项目：

npm run build

调试

可以使用 MCP Inspector 工具调试 MCP 服务：

npm run inspector

反馈与支持

如有问题，请提交 Issue 或联系维护者。