YApi 有哪些成熟的 IDEA 和 VS Code 插件?
YApi 有成熟的 IDEA 和 VS Code 插件,核心用于接口文档自动生成、上传与管理,以下是主流插件及快速使用指南。
一、IDEA 主流插件(后端优先)
| 插件名 | 核心功能 | 适用场景 | 安装与配置 |
|---|---|---|---|
| EasyYapi | 注解解析生成文档、一键上传到 YApi、支持多模块 / 多环境 | Spring Boot 等 Java 项目 | 1. 插件市场搜 EasyYapi 安装;2. 配置 YApi 地址、项目 Token/ID;3. 右键 Controller 或方法上传 |
| YapiUpload | 快速上传接口到 YApi、支持配置持久化 | 轻量 Java 接口上传 | 1. 插件市场搜 YapiUpload 安装;2. 在 .idea/misc.xml 配置 yapiUrl、projectToken、projectId;3. 右键方法 / 类上传(快捷键 Alt+U) |
| Generate Api Plus | 支持 REST 接口上传 YApi、普通接口生成 Markdown | 混合接口(REST + 非 REST) | 1. 插件市场搜 Generate Api Plus 安装;2. 右键 Controller 选择 Generate Api Plus 上传 |
二、VS Code 主流插件(前后端通用)
| 插件名 | 核心功能 | 适用场景 | 安装与配置 |
|---|---|---|---|
| VSCode EasyAPI | 从代码注释生成并上传 YApi 文档、智能更新接口 | JavaScript/TypeScript/Java | 1. 扩展市场搜 VSCode EasyAPI 安装;2. 命令面板执行 Set YApi Server and Project Token;3. 选中代码或文件导出 |
| yapi2code | 基于 YApi 生成 JS/TS/Dart 代码、接口预览 | 前端代码生成 | 1. 扩展市场搜 yapi2code 安装;2. 配置 YApi 地址与项目信息;3. 从 YApi 拉取接口生成代码 |
| vscode-yapi | 接口文档预览、悬浮提示、模板生成 | 接口查询与快速开发 | 1. 扩展市场搜 vscode-yapi 安装;2. 配置 YApi 地址、项目 Token;3. 右键接口查看文档或生成模板 |
三、通用配置要点
- 获取 YApi 项目信息:在 YApi 项目 → 设置 → 项目配置中,获取项目 ID、项目 Token、YApi 服务地址(如 http://127.0.0.1:3000)。
- 权限校验:确保 Token 有上传 / 更新接口的权限,避免 403 错误。
- 版本兼容:插件需与 YApi 服务端版本兼容,建议使用最新版插件与 YApi(v1.12+)。
四、常见问题
- 上传失败:检查 YApi 地址是否正确、Token 是否有效、网络是否可达。
- 解析异常:确保代码注释规范(如 Java 用 Javadoc、JS 用 JSDoc),插件依赖注释解析接口信息。
- 版本冲突:更新插件到最新版,或回退到兼容版本。