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 服务器或其他任何服务器,安全性拉满。

相关推荐
东风破_1 天前
Vibe Coding 上头之后,我开始用 SDD 给 AI 编程加一张“施工图”
人工智能·程序员
万邦科技Lafite1 天前
阿里巴巴拍立淘按图搜索商品API返回值实践:提升用户购物满意度的关键措施
开发语言·api·开放api·电商开放平台·京东开放平台
程序员cxuan2 天前
DeepSeek 多模态深度实测,确实有东西的
人工智能·后端·程序员
Hilaku2 天前
外包前端和大厂前端,写的代码到底有什么本质区别?
前端·javascript·程序员
程序员cxuan2 天前
一招让你的 Claude 被封了也能用
人工智能·后端·程序员
SimonKing2 天前
AI逆向实战:一个壁纸网站被我5分钟摸透了,你也能
java·后端·程序员
咔咔学姐kk2 天前
小白程序员必收藏:轻松入门AI Agent开发,大厂校招新风口!
人工智能·深度学习·ai·程序员·大模型·就业·大模型学习
VIP_CQCRE2 天前
用 Ace Data Cloud 快速接入 Suno:把 AI 音乐生成能力集成进你的产品
人工智能·api·suno·ai音乐·acedatacloud
诸神缄默不语2 天前
如何批量删除Word中的空行(包括只有空格、Tab的行)
程序员
两万五千个小时2 天前
DeepSeek Harness 从 0 开始:19 jobs 后台任务
人工智能·程序员·架构