产品简介
easy-api 面向使用IntelliJ IDEA进行Java/Kotlin后端开发的程序员。它能直接分析你的代码,自动生成并导出清晰的API文档到Markdown、Postman等常用格式,同时创建可运行的HTTP请求,免去手动编写和同步的麻烦,让API开发与调试更高效。
核心功能
- 支持将API导出为Markdown、Postman、cURL、HTTP Client等多种格式。
- 内置API Dashboard工具窗口,以树状图浏览、搜索和管理项目所有API端点。
- 可在IDE内直接编辑参数并发送HTTP请求,查看带语法高亮的响应。
- 使用IDE全局搜索功能,通过路径、方法名等快速定位API。
- 支持将类字段一键转换为JSON、JSON5、YAML、Properties等格式。
快速开始
- 在IntelliJ中安装EasyApi插件。
- 在代码中右键点击Controller文件、类或方法,选择 EasyApi → Export,选择目标格式(如Postman、Markdown)进行导出。
- 右键点击一个Controller方法,选择 EasyApi → Call,或使用快捷键 `Ctrl+Shift+C` (Windows/Linux) / `Ctrl+C` (macOS)。
- 在弹出的API Dashboard中查看或编辑请求参数,然后发送请求查看响应。
界面预览
与其他方案对比
| 对比项 | easy-api | 同类方案 |
|---|---|---|
| 与手动编写文档对比 | 从源代码自动解析生成,保证文档与代码实时同步,避免手动维护的遗漏和错误。 | 需手动编写或使用Swagger UI等工具,存在文档与代码不一致的风险,维护成本高。 |
| 与独立API工具(如Postman)对比 | 深度集成在IDE中,无需切换窗口,直接从代码导出可执行的请求,开发和测试流程更连贯。 | 通常需要手动构建请求URL和参数,或导入导出,与代码编写环境分离。 |
适合谁用
- 使用IntelliJ IDEA进行Java/Kotlin Web后端开发的程序员
- 需要与前端或测试团队共享API文档和请求集合的后端开发者
- 希望快速测试和调试Spring MVC/JAX-RS等框架API的开发者
下载与版本
当前最新版本为 v3.1.6,发布于 2026-07-05。支持 多平台。点击页面「下载软件」按钮即可下载打包好的版本,根据你的电脑/手机系统来选择对应的软件。
注意事项
- 本工具仅供学习和研究使用,请遵守相关法律法规。
- 请尊重内容创作者版权,勿将下载内容用于商业或非法传播。
- 项目源码地址:https://github.com/tangcent/easy-api