Java 代码自动生成 API 文档

什么是 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  官网登录  https://apifox.com/  点击 Apifox 中的个人头像，选择「账号设置 - API 访问令牌」即可获取，可以根据个人需要设定令牌有效期。

 

 

 

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

 

 模块这里选择controller控制层类，在个人团队，选择你自己在apifox官网添加的项目名称

 然后在controller控制层选择一个控制层运行

 最后，在apifox官网中就可以看到您运行的接口已经上传在您得项目中