一款面向 Spring Boot 开发者的 VS Code 插件,自动解析 Controller 生成接口文档,内置 HTTP 测试客户端,一键同步到 Apifox 平台。
版本历史
| 版本 | 变更说明 | 下载 |
|---|---|---|
| 1.2.6 | 优化接口文档导出逻辑,新增导出环境选择 | 下载 |
| 1.2.5 | HTTP 请求参数、请求头和表单数据表格新增「全选」复选框 | 下载 |
| 1.2.4 | 优化 Markdown 导出及 HTTP 请求参数处理,支持 query 类型 object 参数自动展开 | 下载 |
| 1.2.3 | 修复已知问题 | 下载 |
功能一览
| 功能 | 免费版 | Plus |
|---|---|---|
| API 列表查看(三级树结构) | ✅ | ✅ |
| 搜索 API / 跳转到定义 | ✅ | ✅ |
| 同步 API 到 Apifox | ✅ | ✅ |
| 多项目配置 | ✅ | ✅ |
| HTTP 请求测试 | - | ✅ |
| 请求历史记录 | - | ✅ |
| 多环境管理 | - | ✅ |
| 默认请求头配置 | - | ✅ |
| 接口文档导出 | - | ✅ |
| 接口收藏夹(规划中) | - | ✅ |
Plus 功能需要激活 License 或使用 7 天免费试用。
核心功能
Spring Controller 解析
基于 ANTLR4 语法分析引擎,自动解析 Java 源码中的 Spring 注解:
@RestController/@Controller/@RequestMapping@GetMapping/@PostMapping/@PutMapping/@DeleteMapping@PathVariable/@RequestParam/@RequestBody
支持 Swagger 注解:
@Api/@ApiOperation- 接口描述@ApiModel/@ApiModelProperty- 模型描述@ApiParam- 参数描述@Tag/@Operation/@Parameter- OpenAPI 3 注解
API 列表与导航
侧边栏提供三级树形结构展示所有 API:
📁 项目名称
📁 用户管理 (@Tag)
├─ GET /api/users 查询用户列表
├─ POST /api/users 创建用户
└─ GET /api/users/{id} 获取用户详情
- 点击接口跳转到代码定义
Ctrl+\全局搜索 API
一键同步到 Apifox
- 全量同步:命令面板执行「上传API文档到Apifox」
- 选择性同步:勾选接口后点击同步按钮
- 按标签同步:右键标签节点上传该分组
HTTP 请求测试 (Plus)
内置 HTTP 客户端,直接在 VS Code 中测试 API:
- 支持 GET / POST / PUT / DELETE / PATCH
- 自动提取查询参数和请求体模板
- 可视化环境切换
多环境管理 (Plus)
支持为每个项目配置多个运行环境,快速切换 LOCAL / DEV / PROD。
默认请求头 (Plus)
配置全局默认请求头,自动附加到所有请求,如 Authorization、X-Tenant-Id 等。
接口文档导出 (Plus)
支持将接口文档导出为多种格式:
- OpenAPI JSON - 标准 OpenAPI 3.0 规范格式
- Postman Collection - 可直接导入 Postman 使用
- Markdown - 方便分享给前端
接口收藏夹 (Plus)
支持收藏常用接口,快速访问,提升开发效率。
配置文件
插件使用项目级配置文件 .vscode/apifox-config.json,每个项目独立配置:
{
"apiKey": "afxp_xxxxxxxxxxxx",
"apifoxProjectId": "123456",
"projectName": "my-project",
"apifoxModuleId": 789
}
| 字段 | 说明 |
|---|---|
apiKey |
Apifox API 密钥,用于同步接口文档 |
apifoxProjectId |
Apifox 项目 ID |
projectName |
项目名称(用于树形结构显示) |
apifoxModuleId |
Apifox 模块 ID(可选,用于指定同步目标模块) |
福利活动
🎁 前 30 名用户永久免费使用 Plus 全部功能!
关注作者公众号「Jc的程序员笔记」,回复 apifox 添加作者微信,即可领取永久免费 License,名额有限,先到先得。
未来规划
如果你有想要的功能或建议,欢迎联系开发者(关注公众号「Jc的程序员笔记」,发送 apifox 添加作者微信)
License
- 免费版:API 解析、列表查看、搜索跳转、同步到 Apifox 完全免费
- Plus:HTTP 测试、请求历史、多环境管理等高级功能需激活 License
- 免费试用:7 天免费体验全部 Plus 功能
- 限时福利:前 30 名用户可永久免费使用(详见上方「福利活动」)
Plus 订阅方案
| 方案 | 价格 | 设备数 | 有效期 |
|---|---|---|---|
| 月度订阅 | 2 台 | 30 天 | |
| 季度订阅 | 2 台 | 90 天 | |
| 年度订阅 | 2 台 | 365 天 | |
| 终身买断 | 360 CNY | 5 台 | 永久 |
购买或领取福利请联系开发者(关注公众号「Jc的程序员笔记」,发送 apifox 添加作者微信)