Idea集成Yapi插件實現(xiàn)自動生成接口文檔
一個努力中的公眾號
長的好看的人都關(guān)注了
前言
API接口在設(shè)計時往往需要編寫大量的文檔，而且編寫完成后往往需要根據(jù)實際情況經(jīng)常改動文檔，這使得文檔編寫維護工作量相對較大，讓很多的開發(fā)者都很頭疼。此外，伴隨著接口版本的迭代開發(fā)，接口文檔也需要同步更新。而且接口開發(fā)完成以后，做接口測試會十分不方便，要是遇上接口數(shù)量多、參數(shù)負(fù)載的情況，那不僅不方便，測試工作量會重上加重。
Yapi 可以幫助開發(fā)者輕松創(chuàng)建、發(fā)布和維護不同項目，不同平臺的API。有了YAPI，我們可以很方便的測試、管理和維護多個項目的API接口，不像Swagger那樣是隨應(yīng)用生和滅的(且線上環(huán)境下大多數(shù)須關(guān)閉)。
Yapi 是一個獨立的服務(wù)平臺，但是仍需要手動維護相關(guān)接口文檔，如果項目體量較大，接口繁雜過多就會讓后續(xù)開發(fā)十分痛苦。
那么這個時候如果可以自動生成相關(guān)接口文檔，就勢必成為了急需品、在Idea中有一款插件"easy-yapi",可以在保持代碼零侵入的情況下得到相當(dāng)完整的api文檔, 但是特殊的需求還是需要部分特殊的注釋/注解配合與之相對的是, 你可以靈活的運用配置規(guī)則來適應(yīng)你的項目特性以減少代碼侵入。
1. Idea安裝插件：easy-yapi
2. 安裝后重啟Idea
3. 打開settings、在Other Settings下打開EasyApi菜單，配置Yapi服務(wù)器地址(只需要對應(yīng)的ip與端口即可，不需要具體那個項目)
4. 打開對應(yīng)需要生成Yapi文檔的Controller、 同時按住Shift + Alt + E、會出現(xiàn)以下彈框
5. 選中需要生成的接口的方法、點擊彈框右上角綠色鉤子、會彈出一個輸入框，讓你輸入Yapi對應(yīng)項目下的token
6. 將Yapi上面的token復(fù)制、粘貼到Idea的彈框中
7. 點擊ok 然后會在控制臺打印輸入生成結(jié)果，生成成功會打印success、如果生成失敗：一般是Yapi服務(wù)器配置多了項目路徑、或者是沒有Yapi的操作權(quán)限
生成成功就會在Yapi上面自動創(chuàng)建好對應(yīng)的接口文檔
