API 管理工具插件

一个强大的API接口管理工具，无缝对接YAPI平台

🚀 快速开始

1. 配置文件设置

在项目根目录下创建 ytt.json 配置文件（支持自动生成）：

通过可视化操作生成配置文件,点击插件面板中的"自动创建配置"按钮

配置文件示例 (ytt.json)：

[
  {
    "projectId": 8655,
    "token": "your_project_token"
  }
]

如何获取配置信息：

1. 登录YAPI平台 → 进入项目 → 设置 → 获取项目ID

2. 在"token配置"中复制项目token

✨ 核心功能

接口管理

• 自动同步YAPI接口

✅ 手动刷新（右键菜单或工具栏顶部刷新图标） ⏳ 定时自动刷新（开发中...）

类型生成

• 一键生成TypeScript类型定义

• 请求参数类型

• 返回参数类型

• 支持复制到剪贴板

• 支持插入到当前编辑器

快捷操作

• 快速跳转

🌐 一键在浏览器打开接口文档 • 智能搜索

🔍 支持按接口名称/路径/方法快速过滤

多项目管理

• 同时管理多个YAPI项目

• 独立配置每个项目

• 统一视图展示所有接口

🛠 使用方法

1. 查看接口列表： • 左侧面板展示项目分组

   • 点击项目名称展开接口列表

2. 使用接口： • 点击接口名称 → 查看详情

   • 右键菜单 → 生成类型/跳转文档

   • 双击路径 → 在浏览器打开

3. 搜索接口： • 使用顶部搜索框

   • 支持模糊匹配：

   ◦ 接口名称

   ◦ 请求路径

   ◦ 请求方法(GET/POST等)

📌 注意事项

1. 首次使用需要配置有效的 ytt.json
2. token 需要有这个项目的权限才能查看
3. 大项目首次加载可能需要较长时间

🔮 未来计划

定时自动刷新接口

接口变更通知

让API管理更简单高效
使用文档 | YAPI平台