vscode-yapi-接口文檔高效工具

以前 vscode-yapi 插件發佈的時候，顯得有些倉促，文檔也都沒有，給使用者形成了一些困惑，如今把文檔補上了，按我以前的意願實現了大部分功能，今天正好從新分享一下。

首先在這裏很是感謝yapi團隊對openapi的支持，纔有了今天vscode-yapi的出現。其實我剛開始本只想作成公司內部的插件，後面作着作着本身心想既然有它的價值，爲什麼不把它作成vscode-yapi插件發佈出去。

vscode-yapi 是基於 vscode extension + yapi openapi 開發的一款接口文檔高效工具。

vscode-yapi 文檔地址：lisiyizu.github.io

vscode-yapi 更新日誌：github.com/lisiyizu/vs…

開發 vscode-yapi 的目的：

• 統一前端團隊在接口定義的規範
• 提高接口文檔的可維護性
• 提高前端團隊對接接口文檔的效率

vscode-yapi 的功能以下：

• 插件設置：yapi配置、主題設置、項目token管理
• 模板設置：參數模板、api模板
• 接口文檔：光標定位接口，右鍵直接查看接口文檔
• 管理中心：跨項目的去勾選，快速生成api模板定義
• 快速生成模板代碼：快速直接生成模板代碼

vscode-yapi 功能界面以下：

插件設置界面

模板設置界面

接口文檔界面

管理中心界面

快速生成模板代碼

截止到目前爲止，vscode-yapi 發佈有20 天了，很高興已經有一些人去使用它了。目前的安裝下載量大概有 115 人次了。最新版本已經更新到 v1.1.5了。

開發插件不賺錢，徹底是爲了交個朋友！

對於前端開發來講，接口聯調的時間佔據了咱們大部分的時間，每當想起咱們來回的從瀏覽器 和 IDE之間來回切換接口文檔的時候。這種體驗我就感受有點痛苦，首先這個是有點浪費時間，影響工做效率，其次作的也都是來回的複製粘貼。這種狀態讓我這種'懶人'萌生了是否能夠開發一款 vscode-yapi 插件來解決這個問題。一開始沒思路不知道開發一款vscode插件從何入手，本身也沒把握這個事情能作成。說到這裏要感謝早早聊大會，同時更要感謝一我的，他是早聊二期分享的嘉賓，來自阿里媽媽@崇志。我對他分享的東西印象比較深，他分享了他們團隊開發的 vscode-magix 插件，而且開源了(github.com/thx/vscode-…)。vscode-magix 便成了vscode-yapi 的導師和燈塔。在這裏建議有想法開發或者學習vscode插件的同窗，能夠參考下vscode-magix項目。

安利一下：若是大家公司接口管理平臺用的是yapi，而大家前端團隊剛好也在用vscode IDE，不妨試一下這個插件。

但願後續能夠有更多有想法的人加入進來一塊兒去維護它，一我的的想法畢竟有限。若是你對vscode-yapi 插件有一些想法 或 建議，歡迎入羣交流，[vscode-yapi-溝通交流羣] QQ羣號：1065561413 

若是你以爲還能夠，歡迎點贊👍👍👍支持、留言評論。

筆者正在觀望工做機會，本人在北京，有坑位歡迎推薦。