javadog-net

@

前言

??緣由

接口文檔對接爽，整理起來真費腦

對于整理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天