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

前言

原因

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

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

⏲️本文浏览时长

约10分钟

前置条件

1. IDEA开发工具

2. Apifox(不必要)

次要指标

一秒生成接口文档

水图

IDEA中我的项目接结构图

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

生成到Apifox接口文档图

试用人群

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

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

注释

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

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

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

关上apifox-api.md文件查看

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

点击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】

3.生成文档

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

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

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

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

写在最初

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

411天