Java IDEA 插件新升级,帮助生成 API 文档
![Java IDEA 插件新升级,帮助生成 API 文档](https://static001.geekbang.org/infoq/dd/dd4bbc2f11fa61a0710571271dc2012b.png)
还有多少人不知道 Apifox 有 IDEA 插件?
结合用户反馈,我们对 IDEA 插件「Apifox Helper」进行了全面升级优化,我不允许还有人不知道有这么好用的插件!快来一起看看吧!
什么是 Apifox Helper
「Apifox Helper」是 Apifox 针对 IntelliJ IDEA 推出的插件,可以本地识别 Java 、Kotlin 后端项目的源代码,自动生成 API 文档 并同步到 Apifox 项目中,团队成员可即时查看文档内容,实现团队内高效协作。
![](https://static001.geekbang.org/infoq/00/003f43d87ba49e11e9e6411100be5e3e.png)
对于常见的框架开箱即用,真正做到代码零入侵:
![](https://static001.geekbang.org/infoq/52/5210e116a396054663f5991ecc1f2392.png)
如何使用 Apifox Helper
1 安装
在 IntelliJ IDEA 的插件 Marketplace 内搜索 Apifox Helper 即可进行安装,支持 IntelliJ IDEA 2019.3 及更高的版本。
![](https://static001.geekbang.org/infoq/78/78eaae19b299e1fa76a85a95f995f1c0.png)
2 配置
要使用 Apifox Helper,需要先在 Apifox 中配置 API 访问令牌。
点击 Apifox 中的个人头像,选择「账号设置 - API 访问令牌」即可获取,可以根据个人需要设定令牌有效期。
![](https://static001.geekbang.org/infoq/d8/d81479f9fa8b8e1ec80c3ef0104c797b.png)
获得令牌后,将自己的 API 访问令牌填写至 Apifox Helper 中,然后点击「测试令牌」。如果显示「成功」,就可以开始使用 Apifox Helper 了!
![](https://static001.geekbang.org/infoq/60/60afdceb954f61a2dce43cdae9264096.png)
如需在 Apifox 项目中与团队其他成员协同,则需要导出文档,再自行导入到 Apifox,步骤繁琐且信息同步不及时。使用「Apifox Helper」可实现一键上传到 Apifox 项目中,自动生成完整的 API 文档,无需导出操作。团队成员即可使用 Apifox ,在项目中完成接口调试、自动化测试 等工作。
Apifox Helper 全面升级
1 简化的项目配置
Apifox 在本次更新中将配置步骤进行了简化,将手动输入项目代码的配置方式改为可视化弹窗操作,以目录树的形式展现团队项目,按需选择项目或项目内的目录即可。数据模型无需配置,默认上传至接口所在项目的数据模型根目录。
![](https://static001.geekbang.org/infoq/d8/d8e098fb5753bc688ba3d7ddd485d561.png)
同时,我们将「冲突处理」和「文档风格」的配置简化成下拉框选择模式,根据个人需求选择对应的处理方式即可,非常便捷贴心。
![](https://static001.geekbang.org/infoq/fe/fe59833d38363845e9e6f5bfb71725ce.png)
2 上传后 Apifox 自动刷新
当在 IDEA 项目中有接口信息变动,只需右键选择「 Upload to Apifox」即可实时同步更新至 Apifox,无需手动刷新即可在 Apifox 中看到最新的接口信息,无需奔走相告,提升团队协作效率。
需要注意的是,实现自动刷新同步需要将 Apifox 升级至最新版。
![](https://static001.geekbang.org/infoq/7d/7d3d9aee5ab689bb62bbffc9fd40aa38.png)
支持同步以下范围内的接口:
模块内的全部接口:在左侧目录树的模块节点,右键选择「Upload to Apifox」
Controller 内的全部接口:在 Controller 文件内部,右键选择「Upload to Apifox」
3 更清晰的规则分类
在本次更新中,我们对复杂难懂的内置规则进行了分类整理,并配备了相关规则的解释,按需勾选规则即可。其中部分框架规则支持高级配置,可以更精准的制定所需规则。
如果有内置规则不能满足的情况,也支持添加订阅规则或自定义规则,灵活处理。
![](https://static001.geekbang.org/infoq/49/49bbdbfb96644b6e96646af35903d563.png)
4 安全与隐私
对 Java 、Kotlin 源代码的识别,是由 Apifox Helper 在用户本机执行,永远不会被上传至 Apifox 服务器或其他任何服务器,安全性拉满。
评论