关于后端:Apifox-Helper自动生成接口文档IDEAApifox懒人必备

对于 整顿 API 文档 ，本狗秉承偷懒为上的准则，想找一种 在 IDEA 中间接生成文档 的办法。Apifox Helper绝绝子，只须要在 IDEA 中下载插件，无脑配置后， 文档主动生成到 Apifox，美完满解决。并且 颜值及不便水平 绝比 Swagger 和 postman 好太多。

想理解上图模块分层办法的同学，能够参考《还不会 SpringBoot 我的项目模块分层？来这手把手教你》

点击 File=>Settings，找到 Plugins, 输出 Apifox Helper，点击装置，而后期待胜利后 重启 IDEA, 肯定重启才会失效！！！

🎯Tips: 你能够抉择 同步到 Apifox 我的项目中，也能够间接导出 markdown 文档 。如果是同步到 Apifox 我的项目，你还须要下载或注册 Apifox 软件，并查看上面【Apifox Helper】的配置规定。如果不须要则只须要在我的项目中找到须要生成文档的 Controller，右键后 Export Markdown, 间接导出apifox-api.md 到对应目录。

关上 apifox-api.md 文件查看

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

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

https://api.apifox.cn

##### 2. API 拜访令牌

关上 Apifox 软件，点击左侧【头像】，点击【账号设置】，找到 API 拜访令牌

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

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

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

关上 Apifox 软件，新建我的项目，本狗我的项目名为【bkb】, 并确认

进入我的项目【bkb】，点击【我的项目设置】，点击【根本设置】，复制我的项目 ID

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

右击【bkb-boot-controller】模块，点击【Upload to Apifox】，期待实现即可

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

查看成绩，功败垂成，之后便可随心所欲了

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

411 天

关于后端:Apifox-Helper自动生成接口文档IDEAApifox懒人必备

前言

🍊原因

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

⏲️本文浏览时长

约 10 分钟

🥮前置条件

1. IDEA 开发工具

2. Apifox(不必要)

🎯次要指标

一秒生成接口文档

🍩水图

IDEA 中我的项目接结构图

生成到 Apifox 接口文档图

👨‍🎓试用人群

1. 像本狗一样【偷懒】不违心整顿接口文档

2. 学习新鲜文档生成及治理形式

注释

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

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

🌈3. 生成文档

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

写在最初