IDEA 插件新体验:Java 代码自动生成 API 文档

还有多少人不知道 Apifox 有 IDEA 插件?

结合用户反馈,我们对 IDEA 插件「Apifox Helper」进行了全面升级优化,我不允许还有人不知道有这么好用的插件!快来一起看看吧!

什么是 Apifox Helper

「Apifox Helper」是 Apifox 针对 IntelliJ IDEA 推出的插件,可以本地识别 Java 、Kotlin 后端项目的源代码,自动生成 API 文档 并同步到 Apifox 项目中,团队成员可即时查看文档内容,实现团队内高效协作。

对于常见的框架开箱即用,真正做到代码零入侵:

如何使用 Apifox Helper

1 安装

在 IntelliJ IDEA 的插件 Marketplace 内搜索 Apifox Helper 即可进行安装,支持 IntelliJ IDEA 2019.3 及更高的版本。

2 配置

要使用 Apifox Helper,需要先在 Apifox 中配置 API 访问令牌

点击 Apifox 中的个人头像,选择「账号设置 - API 访问令牌」即可获取,可以根据个人需要设定令牌有效期。

获得令牌后,将自己的 API 访问令牌填写至 Apifox Helper 中,然后点击「测试令牌」。如果显示「成功」,就可以开始使用 Apifox Helper 了!

如需在 Apifox 项目中与团队其他成员协同,则需要导出文档,再自行导入到 Apifox,步骤繁琐且信息同步不及时。使用「Apifox Helper」可实现一键上传到 Apifox 项目中,自动生成完整的 API 文档,无需导出操作 。团队成员即可使用 Apifox ,在项目中完成接口调试、自动化测试 等工作。

Apifox Helper 全面升级

1 简化的项目配置

Apifox 在本次更新中将配置步骤进行了简化,将手动输入项目代码的配置方式改为可视化弹窗操作,以目录树的形式展现团队项目,按需选择项目或项目内的目录即可。数据模型无需配置,默认上传至接口所在项目的数据模型根目录。

同时,我们将「冲突处理」和「文档风格」的配置简化成下拉框选择模式,根据个人需求选择对应的处理方式即可,非常便捷贴心。

2 上传后 Apifox 自动刷新

当在 IDEA 项目中有接口信息变动,只需右键选择「 Upload to Apifox」即可实时同步更新至 Apifox无需手动刷新即可在 Apifox 中看到最新的接口信息,无需奔走相告,提升团队协作效率。

需要注意的是,实现自动刷新同步需要将 Apifox 升级至最新版

支持同步以下范围内的接口:

  • 模块内的全部接口:在左侧目录树的模块节点,右键选择「Upload to Apifox」

  • Controller 内的全部接口:在 Controller 文件内部,右键选择「Upload to Apifox」

3 更清晰的规则分类

在本次更新中,我们对复杂难懂的内置规则进行了分类整理,并配备了相关规则的解释,按需勾选规则即可。其中部分框架规则支持高级配置,可以更精准的制定所需规则。

如果有内置规则不能满足的情况,也支持添加订阅规则或自定义规则,灵活处理。

4 安全与隐私

对 Java 、Kotlin 源代码的识别,是由 Apifox Helper 在用户本机执行,永远不会被上传至 Apifox 服务器或其他任何服务器,安全性拉满。

相关推荐
用户1563068103511 小时前
Day01 | Java 基础(Java SE)
java
飘尘1 小时前
前端转型全栈(Java后端)的快速上手指引
前端·后端·全栈
浏览器工程师3 小时前
AI Agent 接浏览器任务,先别让它一路点到底
前端·后端
行者全栈架构师3 小时前
Maven dependency:tree 的 8 个高级用法
java·后端
Chenyiax3 小时前
从一次请求看懂 OkHttp:架构、调度与连接管理
后端
爱勇宝3 小时前
深扒 Anthropic 1680 位工程师简历:应届生几乎没机会,AI 公司最缺的不是博士
前端·后端·程序员
AskHarries4 小时前
工具失败时怎么办:重试、回滚、人工确认和风险提示
后端·程序员
苏三说技术5 小时前
Claude Code从失控到起飞,只用了这些技巧
后端
长栎6 小时前
写 for 循环写了十年,你却从没用过迭代器模式最狠的那一面
后端
LiaCode6 小时前
Redis 在生产项目的使用
前端·后端