【Apifox Helper】自动生成接口文档，IDEA+Apifox懒人必备

落日映苍穹つ 2024-05-11 09:06 10阅读 0赞

#### 文章目录 ####

*   *  前言
     *   *  🍊缘由
         *   *  接口文档对接爽，整理起来真费脑
         *  ⏲️本文阅读时长
         *   *  约10分钟
         *  🥮前置条件
         *   *  1. IDEA开发工具
             *  2. Apifox(不必要)
         *  🎯主要目标
         *   *  一秒生成接口文档
         *  🍩水图
         *   *  IDEA中项目接结构图
             *  生成到Apifox接口文档图
         *  👨🎓试用人群
         *   *  1. 像本狗一样【偷懒】不愿意整理接口文档
             *  2. 学习新颖文档生成及管理方式
     *  正文
     *   *   *  🐋1.在IDEA安装【Apifox Helper】插件
             *  🦢2.修改【Apifox Helper】对应配置
             *   *  1. Apifox服务器地址
                 *  2. API访问令牌
                 *  3. 模块项目ID配置
             *  🌈3.生成文档
             *  🍎4.查看Apifox中自动生成的文档
     *  写在最后

### 前言 ###

#### 🍊缘由 ####

##### 接口文档对接爽，整理起来真费脑 #####

对于**整理API文档**，本狗秉承偷懒为上的原则，想找一种**在IDEA中直接生成文档**的方法。**Apifox Helper**绝绝子，只需要在**IDEA中下载插件**，无脑配置后，**文档自动生成到Apifox**，美完美解决。并且**颜值及方便程度**绝比Swagger和postman好太多。

#### ⏲️本文阅读时长 ####

##### 约10分钟 #####

#### 🥮前置条件 ####

##### 1. IDEA开发工具 #####

##### 2. Apifox(不必要) #####

#### 🎯主要目标 ####

##### 一秒生成接口文档 #####

#### 🍩水图 ####

##### IDEA中项目接结构图 #####

![在这里插入图片描述][f161ce9cb37b4a2bbba109329c444020.png]

想了解上图模块分层方法的同学，可以参考[《还不会SpringBoot项目模块分层？来这手把手教你》][SpringBoot]

##### 生成到Apifox接口文档图 #####

![在这里插入图片描述][1684e21db4784cdab5bfe0164ea9d8a8.png]

#### 👨🎓试用人群 ####

##### 1. 像本狗一样【偷懒】不愿意整理接口文档 #####

##### 2. 学习新颖文档生成及管理方式 #####

--------------------

### 正文 ###

##### 🐋1.在IDEA安装【Apifox Helper】插件 #####

> 点击File=>Settings，找到Plugins,输入 **Apifox Helper**，点击安装，然后等待成功后**重启IDEA**,一定重启才会生效！！！

![在这里插入图片描述][f8d2867dc3c34f41885bbb97ff5f0316.png]  
![在这里插入图片描述][e3abc38bba54422b9cbcadcb765d0640.png]

> 🎯Tips: 你可以选择**同步到 Apifox 项目中，也可以直接导出 markdown 文档**。如果是同步到 Apifox 项目，你还需要下载或注册 [Apifox 软件][Apifox]，并查看下面【Apifox Helper】的配置规则。如果不需要则只需要在项目中找到需要生成文档的Controller，右键后Export Markdown,直接导出**apifox-api.md**到对应目录。

![在这里插入图片描述][bb4669b70f3e47959f9c37653d96353b.png]

> 打开apifox-api.md文件查看

![在这里插入图片描述][d33fc72f73b14d5bab1a674687497607.png]

--------------------

##### 🦢2.修改【Apifox Helper】对应配置 #####

> 点击File=>Settings=>Other Settings，找到 **ApifoxHelper**

![在这里插入图片描述][c2dca06f772e479a8df5f3216c6ea84c.png]

###### 1. Apifox服务器地址 ######

> https://api.apifox.cn

###### 2. API访问令牌 ######

> 打开Apifox软件，点击左侧【头像】，点击【账号设置】，找到API访问令牌

![在这里插入图片描述][0348be242df84f46836a7eedc21ce61a.png]  
![在这里插入图片描述][7bc3c602e7fd4db2a75fe45b48ececb4.png]

--------------------

> 点击新建令牌，填写名称及有效期，本狗填写名称为【IDEA专用】，有效期为【无限期】，点击【保存并生成令牌】

![在这里插入图片描述][75da0c17f3b94efeb19244898b020935.png]

--------------------

> 复制令牌到IDEA中【Apifox Helper】配置项的API访问令牌

![在这里插入图片描述][68bb8b9a2d7a4791b19cd2c809c83a46.png]  
![在这里插入图片描述][45fd961194d94d64878dba07f59424e3.png]

###### 3. 模块项目ID配置 ######

> 打开Apifox软件，新建项目，本狗项目名为【bkb】,并确认

![在这里插入图片描述][69f38d4fc5404158b73dae4690cf3eb6.png]  
![在这里插入图片描述][5df6fb0cd85c4c709287de0a26d5cd22.png]

--------------------

> 进入项目【bkb】，点击【项目设置】，点击【基本设置】，复制项目ID

![在这里插入图片描述][bedbea655f274cbabbac12877bbb4a8b.png]  
![在这里插入图片描述][08dfddc7f50b4fdea123de2b33b0813c.png]

--------------------

> 将上述复制的【ProjectID】到IDEA中【Apifox Helper】配置【模块项目ID配置】，我的ModuleName为【bkb-boot-controller】，所以结构是bkb-boot-controller:xxxxx,点击【OK】

![在这里插入图片描述][8ee2a423016f4d1299eb10145116655f.png]  
![在这里插入图片描述][730173da7d8140f5949de7c3c3a5d531.png]

--------------------

##### 🌈3.生成文档 #####

> 右击【bkb-boot-controller】模块，点击 【Upload to Apifox】，等待完成即可

![在这里插入图片描述][1445c8c6fe234a828f6bcb70bcafa924.png]  
![在这里插入图片描述][2822decc74914d8eb259de222a829424.png]

--------------------

##### 🍎4.查看Apifox中自动生成的文档 #####

> 一定要点击下Apifox软件右上角的刷新！  
> 一定要点击下Apifox软件右上角的刷新！  
> 一定要点击下Apifox软件右上角的刷新！

![在这里插入图片描述][544a895448ec46f98b950cb6707ecea6.png]

> 查看成果，大功告成，之后便可为所欲为了

![在这里插入图片描述][303a77d57f0f493a92c39acf48efba2d.png]

--------------------

### 写在最后 ###

> 此生两悔，悔遇见你，更悔未早遇见你。

**411天**

![在这里插入图片描述][e74f3636c05a430eab8819333fa004eb.jpeg]

<table> 
 <thead> 
  <tr> 
   <th align="center">JavaDog</th> 
   <th align="center">狗屋地址</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">个人博客</td> 
   <td align="center"><a href="https://blog.javadog.net" rel="nofollow">https://blog.javadog.net</a></td> 
  </tr> 
  <tr> 
   <td align="center">公众号</td> 
   <td align="center"><a href="https://mp.weixin.qq.com/s/_vgnXoQ8FSobD3OfRAf5gw" rel="nofollow">https://mp.weixin.qq.com/s/_vgnXoQ8FSobD3OfRAf5gw</a></td> 
  </tr> 
  <tr> 
   <td align="center">CSDN</td> 
   <td align="center"><a href="https://blog.csdn.net/baidu_25986059" rel="nofollow">https://blog.csdn.net/baidu_25986059</a></td> 
  </tr> 
  <tr> 
   <td align="center">掘金</td> 
   <td align="center"><a href="https://juejin.cn/user/2172290706716775" rel="nofollow">https://juejin.cn/user/2172290706716775</a></td> 
  </tr> 
  <tr> 
   <td align="center">知乎</td> 
   <td align="center"><a href="https://www.zhihu.com/people/JavaDog" rel="nofollow">https://www.zhihu.com/people/JavaDog</a></td> 
  </tr> 
  <tr> 
   <td align="center">简书</td> 
   <td align="center"><a href="https://www.jianshu.com/u/1ff9c6bdb916" rel="nofollow">https://www.jianshu.com/u/1ff9c6bdb916</a></td> 
  </tr> 
  <tr> 
   <td align="center">gitee</td> 
   <td align="center"><a href="https://gitee.com/javadog-net" rel="nofollow">https://gitee.com/javadog-net</a></td> 
  </tr> 
  <tr> 
   <td align="center">GitHub</td> 
   <td align="center"><a href="https://github.com/javadog-net" rel="nofollow">https://github.com/javadog-net</a></td> 
  </tr> 
 </tbody> 
</table>

[f161ce9cb37b4a2bbba109329c444020.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/3472eda05afc4519bba2c0d4989d0a0f.png
[SpringBoot]: https://blog.csdn.net/baidu_25986059/article/details/128739849
[1684e21db4784cdab5bfe0164ea9d8a8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/3f5e4ab05cf14b43905f17ccefbd98e2.png
[f8d2867dc3c34f41885bbb97ff5f0316.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/edecbbf6debb4ea38a0a868c7120c689.png
[e3abc38bba54422b9cbcadcb765d0640.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/f6dc981615094159b1047510fea84e9a.png
[Apifox]: https://www.apifox.cn/
[bb4669b70f3e47959f9c37653d96353b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/7a64ee7017aa4d04b3b0580aebe1ce29.png
[d33fc72f73b14d5bab1a674687497607.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/87797077d43b407eb059642a807021fe.png
[c2dca06f772e479a8df5f3216c6ea84c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/c244eb028b114603b9d94864fc42e893.png
[0348be242df84f46836a7eedc21ce61a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/6ee143fc73a247ea9cde61196be111c7.png
[7bc3c602e7fd4db2a75fe45b48ececb4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/1fd1ae0d83be439ab457480e7863de23.png
[75da0c17f3b94efeb19244898b020935.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/c6b4072cd5cd4d87b753467851273e5c.png
[68bb8b9a2d7a4791b19cd2c809c83a46.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/c3d39cebc71243478e12beb3a5b78702.png
[45fd961194d94d64878dba07f59424e3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/1b7725345479418081bdb461e8f95d6b.png
[69f38d4fc5404158b73dae4690cf3eb6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/67d0cde98b9344dcb5cfdb8693d227ff.png
[5df6fb0cd85c4c709287de0a26d5cd22.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/fde29f94e1884e919ea0211695d80472.png
[bedbea655f274cbabbac12877bbb4a8b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/0a4867b53237449f9a62e376377babe3.png
[08dfddc7f50b4fdea123de2b33b0813c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/d0d4ef60b30b48af9b92ce40b0a9fca9.png
[8ee2a423016f4d1299eb10145116655f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/749b94a0073b4c6a9ad12fe165af4c1c.png
[730173da7d8140f5949de7c3c3a5d531.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/4641040c96eb40859f0a588d38575d22.png
[1445c8c6fe234a828f6bcb70bcafa924.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/389dd4113c8e40baaee2fcdace53359a.png
[2822decc74914d8eb259de222a829424.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/ad04d099db934fc585ff9311fe794244.png
[544a895448ec46f98b950cb6707ecea6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/5880e322ec2240dcbc84ef2843c9e75f.png
[303a77d57f0f493a92c39acf48efba2d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/91736367e14c4794b5a839d99c56887b.png
[e74f3636c05a430eab8819333fa004eb.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/fa089c5decf1417e893f3b490145f87e.jpeg