你還在用 word、markdown 埋頭苦干寫接口文檔？寫文檔這件事恐怕是每個開發(fā)都萬分抗拒的事情了。本篇文章詳細(xì)教你如何利用插件工具，在 IDEA 中自動生成 API 文檔。

先來看看從 IDEA 中生成文檔的效果如下圖。下圖是使用 Apifox 插件（Apifox helper）從 IDEA 生成的文檔（右）效果。

第一步：安裝插件

打開你的 IDEA，點(diǎn)擊 File -->Settings --> Plugins,輸入 Apifox Helper。 點(diǎn)擊安裝，然后等待成功后重啟 IDEA.

你也可以通過 Jetbrains Marketplace 的官網(wǎng)下載安裝。

第二步：注冊一個 Apifox 賬號

Apifox 是一個在線的接口文檔管理工具，這一步主要是用來同步文檔到項(xiàng)目中。支持下載桌面端或直接網(wǎng)頁注冊，并且創(chuàng)建一個項(xiàng)目。

第三步：配置令牌

接下來，你需要將 Apifox Helper 和 Apifox 的項(xiàng)目進(jìn)行關(guān)聯(lián)，也就是通過訪問令牌綁定。

1、打開 Apifox， 點(diǎn)擊左側(cè)【頭像】-->【賬號設(shè)置】-->【API 訪問令牌】；

2、點(diǎn)擊【新建令牌】，填寫令牌名稱，點(diǎn)擊【保存并生成令牌】。

3、復(fù)制令牌到 IDEA 中【Apifox Helper】配置項(xiàng)的 API 訪問令牌中。同理，在 Apifox 中進(jìn)入項(xiàng)目，【項(xiàng)目設(shè)置 --> 基本設(shè)置】，復(fù)制項(xiàng)目 ID 。

4、在 IDEA 中，點(diǎn)擊 File-->Settings -->Other Settings，找到 Apifox Helper。 將訪問令牌和項(xiàng)目 ID 粘貼到這里：

（服務(wù)器地址就用默認(rèn)的，可以不用管。）

到這里，你就搞定了配置部分，下面就是自動生成文檔了！

第四步：生成文檔！

打開需要上傳的 Controller 文件，右鍵選擇「 Upload to Apifox」。

第五步：去 Apifox 項(xiàng)目中查看自動生成的文檔

點(diǎn)擊 Apifox 右上角的刷新圖標(biāo)。剛才在 IDEA 項(xiàng)目中的接口文檔就已經(jīng)在這里了。

自此，你就大功告成了！恭喜你已經(jīng)擁有了一份美觀整潔的接口文檔。這個項(xiàng)目一旦有更新，你只需要右鍵點(diǎn)擊「 Upload to Apifox」 就可以。

更多好用的功能

當(dāng)你的文檔同步到項(xiàng)目中，那么你就可以直接在 apifox 中直接生成一個分享鏈接給別人，那么他看到的文檔就都是最新的，不需要再管你索要接口文檔文件。

還可以直接在 Apifox 項(xiàng)目中直接發(fā)起接口調(diào)試、接口自動化測試等等操作。相較于 Postman，Apifox 結(jié)合它的插件 Apifox Helper 可以通過代碼注解自動解析生成 API 文檔，無需手動操作，同時支持遠(yuǎn)端同步，非常方便團(tuán)隊(duì)內(nèi)的協(xié)作和更新。這是一種新型的在線協(xié)作方式，能夠非常高效率幫助你進(jìn)行 API 接口的分享和管理。懶人必備！ 另附帶 Apifox 插件官方幫助文檔 ，幫助你使用。

更多關(guān)于接口文檔的相關(guān)知識

• 高效實(shí)用的方法，讓程序員愛上寫接口文檔
• 接口文檔誰來寫？

到此這篇關(guān)于Java項(xiàng)目自動生成接口文檔教程的文章就介紹到這了,更多相關(guān)Java 自動生成接口內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！ 

最新評論