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. 大项目首次加载可能需要较长时间

🔮 未来计划

定时自动刷新接口

接口变更通知

一个便捷的Doraemon组件提示工具，快速获取组件信息

✨ 核心功能

组件名补全提示

• 组件相关描述、介绍

• 组件所属分类

• 组件链接地址: 点击打开组件文档

组件属性补全提示

1. 精确提示组件属性信息

• 属性相关描述

• 属性类型

• 属性默认值

• 组件链接地址: 点击打开组件文档

2. 快速回填属性

• 字符串：插入属性名=""，光标移动至双引号内

• 布尔值：插入属性名=下拉选项，可以切换选择true / false

• 其它类型：插入属性名={}，光标移动至{}内

组件信息悬浮提示

1. 组件信息提示

   • 组件链接地址: 点击打开组件文档

   • 组件完整信息表格(参数、说明、类型、默认值、支持的版本)

   • 子组件信息表格

2. 组件属性信息

   • 属性相关描述

   • 属性类型

   • 属性默认值

   • 属性支持的版本

组件文档快捷入口

• 组件名（组件中文名）

• 支持根据组件名模糊匹配组件

🛠 使用方法

1. 组件名补全

   • tsx/jsx文档中，键入<，获取所有doraemon组件及相关信息（描述、分类等）

   • 继续键入属性字符，可筛选获得更精确结果

   • 上下键可切换组件，回车将回填组件名

2. 组件属性补全

   • 光标移动至组件开标签内，键入空格/回车，获得相关属性提示

   • 继续键入属性字符，可筛选获得更精确结果

   • 上下键可切换键入的属性，回车将当前属性插入到光标处

3. 组件信息提示

   • 光标移动至组件名上，获得对应组件信息

   • 光标移动值组件属性名上，获取属性相关信息

4. 文档快捷入口

   • 状态栏右下角doraemon文本，点击打开内置的选择框

   • 输入字符可进行筛选匹配

   • 回车，在浏览器中打开组件文档

📌 注意事项

1. 确保项目中引用了doraemon组件库依赖(dependencies/peerDependencies)
2. 当前数据源来自doraemon 4.2.5，相关信息可能不全，欢迎反馈
3. 当前编辑区不应该存在语法错误，否则无法获取提示
4. 加载可能需要较长时间

🔮 未来计划

• 完善数据源，提供更精确的提示
• 支持插入组件Demo

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