IDEA 插件 | Apifox Helper 2.0 发布,IDEA 内离线调试接口,导出 OpenAPI/Swagger 文件

今天,我们相聚在这里,是为了庆祝——
Apifox Helper 2.0 上线啦 🎉
上个版本的「Apifox Helper」我们优化了自动生成文档及同步到 Apifox 的相关功能(详情可见 Apifox Helper 1.2.1),收获了很多好评,也收到了很多需求反馈。为了满足大家的期待,我们又双叒叕对 IDEA 插件进行了优化升级,带来全新的 IDEA 内调试功能,与 Apifox 客户端的调试体验一致!
这么好用的插件还有谁不知道!快来安装体验!

什么是 Apifox Helper
「Apifox Helper」是 Apifox 针对 IntelliJ IDEA 推出的插件,可以在 IDE 中识别 Java 、Kotlin 后端项目的源代码,直接在 IDE 侧边栏调试接口,自动生成 API 文档并同步到 Apifox 项目中,团队成员可即时查看文档内容,实现团队内高效协作。
对于常见的开发框架开箱即用,实现真正的代码零入侵。

Apifox Helper 2.0 带来了什么惊喜
1. 便捷美观的 IDE 侧边栏调试窗口
只需点击 IDE 侧边栏的 Apifox 按钮即可展开全新的调试界面,包含接口目录、请求地址、请求参数、返回响应等模块,可以选择「上下布局」或「左右布局」,还可以从侧边栏切换为悬浮窗口,适应不同用户的使用偏好。
接口目录采用树状结构,可以一键展开/折叠,根据模块、包、控制器、方法 4 个层级展示接口,同时将 JavaDoc 注释和 URL 路径并列展示,在保持界面整洁美观的同时,提供更全面的信息展示。

2.智能识别代码,自动填写请求参数
打开「Apifox Helper」调试界面时,会自动识别框架代码并填充至请求参数和 URL 模块,非常方便。你可以边写代码边调试接口,节省大量手动输入时间,避免手动输入造成错误的情况,在 API 开发中始终快人一步。
「Apifox Helper」支持 Java 和 Kotlin 语言,对于 Spring 框架 和 Quarkus 等基于 Jakarta RESTful Web Services (JAX-RS) 的框架也能自动识别,是国内目前识别代码最全的插件。

3.强大的请求调试与响应
与 Apifox 客户端一样,调试接口时支持 JSON、XML、form-data 和 x-www-urlencoded 等多种 Body 格式,非常全面好用。
发送请求后,「Apifox Helper」能识别响应体类型(JSON 和 XML 等常用格式),自动执行格式化和代码高亮,提高可读性。对于二进制文件,可以选择下载。如果服务器开启了 Gzip 和 Brotli 压缩,也能正常显示响应内容。

4.灵活的环境与变量管理
「Apifox Helper」会自动识别不同模块的前置 URL,避免手动填写的繁琐,当然,也支持手动修改,适应各种复杂的 API 调用需求。
可以在「全局参数」中配置 Header 等内容,轻松实现如接口鉴权传递 Token 等场景,使调试更高效。还可以查看和清理全局 Cookie,让调试过程更加高效和便捷。

5.贴心的接口搜索与定位功能
「Apifox Helper」支持搜索接口,能够在复杂的项目中快速查找所需接口,缩短手动查找接口的时间,提高接口定位效率。双击接口,还能轻松定位对应接口的相关代码,便于修改和优化接口代码,无缝衔接开发和调试流程。

6.全面的接口请求历史记录
每次发送请求后,「Apifox Helper」会自动记录请求历史,包括 URL、请求参数、响应体等关键数据,随时可以回溯查看。支持查看单个接口历史记录,或全局接口历史记录,灵活满足不同场景的需求。

7.导出 OpenAPI/Swagger 文件
使用「Apifox Helper」,你可选择一键上传至 Apifox ,也可以选择导出 OpenAPI/Swagger 文件,支持更广泛的协作需求,确保无网络环境下也能管理 API 文档。

Apifox Helper 最佳实践
「Apifox Helper」2.0 有两大王牌能力:
- 自动生成 API 文档并同步至 Apifox 项目中
- 直接在 IDE 中快速调试验证接口
使用 「Apifox Helper」,开发人员可以在边写代码边在 IDEA 中离线调试接口,检查接口是否能顺利跑通,无误后可以一键上传到 Apifox 项目中,自动生成完整的 API 文档,无需导出操作。后续代码有任何变动,也可以一键同步更新,团队成员能即刻在 Apifox 中看到更新后的 API 文档,并在项目中完成接口调试、自动化测试等后续工作,不仅帮助开发人员提高开发效率,还同步提升了团队协作能力,真的非常好用。

如何安装 Apifox Helper
在 IntelliJ IDEA 的插件 Marketplace 内搜索 Apifox Helper 即可进行安装,支持 IntelliJ IDEA 2019.3 至最新的 2024.2 版本。

查看往期 IDEA 插件推文:
- 《IDEA 插件 | Apifox Helper 全新升级,简化项目配置,清晰规则分类,自动刷新同步!》
- 《Apifox IDEA 插件 | 「Apifox Helper」帮助开发者快速生成 API 文档》
除了上面提到的这些,Apifox Helper 2.0 还优化了很多细节,具体内容可前往在 IntelliJ IDEA 的插件 Marketplace 下载页查看,在使用上有任何使用问题都可以在 Apifox IDEA 交流群提出哦~
当然,Apifox Helper 还有很多惊喜等你发现,欢迎各位用户继续对 Apifox Helper 提出使用反馈和优化建议,我们会持续更新升级,致力于为大家提供更好的使用体验。