IDEA 插件 | Apifox Helper 全新升级,简化项目配置,清晰规则分类,自动刷新同步!

IDEA 插件 | Apifox Helper 全新升级,简化项目配置,清晰规则分类,自动刷新

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

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

什么是 Apifox Helper

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

Apifox Helper是针对 IntelliJ IDEA 推出的插件,可以识别 Java 、Kotlin 后端项目的源代码


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

Apifox Helper IDEA 插件开箱即用,代码零入侵


如何使用 Apifox Helper

安装

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

在 IntelliJ IDEA 的插件 Marketplace 内搜索 Apifox Helper 即可进行安装

配置

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

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

IDEA 插件需要先在 Apifox 中配置 API 访问令牌


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

将自己的 API 访问令牌填写至 IDEA Apifox Helper 中


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


Apifox Helper 全面升级

简化的项目配置

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

Apifox Helper将手动输入项目代码的配置方式改为可视化弹窗操作


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

Apifox IDEA 插件将「冲突处理」和「文档风格」的配置简化成下拉框选择模式


上传后 Apifox 自动刷新

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

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

Apifox IDEA 插件可实时同步更新至 Apifox,无需手动刷新

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

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


更清晰的规则分类

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

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

Apifox IDEA 插件对复杂难懂的内置规则进行了分类整理


安全与隐私

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


除了上面提到的这些,Apifox Helper 还优化了很多细节,具体内容可以点击「阅读原文」前往在 Apifox 官方帮助文档查看

当然,Apifox Helper 还有很多惊喜等你发现。欢迎各位用户继续对 Apifox Helper 提出使用反馈和优化建议,我们会持续更新升级,致力于为大家提供更好的使用体验。

订阅
qrcode

订阅

随时随地获取 Apifox 最新动态