接口管理工具YApi怎麼用？顏值高、易管理、超好用

衆多接口管理工具如雨後春筍搬冒出。讓人欣慰的是，有許多優秀做品來自國內，包含YApi和rap。

看着中文的官網，熟悉的漢語，不由讓人暗爽。固然這也就帶來另外一個弊端，由於使用基數少，因此參考資料少。咱們想學習使用方法，只能依賴官方文檔，也算是福禍相倚了。

本文將帶您走進Yapi的世界，讓您體驗一回小清新的接口管理工具。

YApi有什麼用

根據統計，市面上互聯網項目超過10億，保守統計涉及的API數量有100億。可是不少API的質量堪憂。由於與API相關的文檔、調試、測試和數據Mock在工做中效率很是低。

咱們急需一款產品，它須要具備接口管理功能，提供調試，文檔管理和測試功能。這時YApi橫空出世。

這是一個接口管理平臺，能夠幫助開發者建立、發佈和維護API。YApi 還爲用戶提供了優秀的交互體驗。開發人員只需利用平臺提供的接口數據寫入工具以及簡單的點擊操做就能夠實現接口的管理。

圖片來自YApi官網

YApi的安裝並非點點點，你須要下載mongoDB數據庫，而後才能夠部署。因爲文章篇幅有限，就不展現具體安裝過程了。

YApi的地位如何

YApi適合公司業務比較複雜，尤爲是跨部門協做的狀況下使用，和它相似的工具還有rap、swagger、moco。

rap也具備圖形界面，但火爆程度逐漸不如yapi。而swagger呢，是一個超級強大的工具，它的野心已經不知足於接口管理，後續課程會講到它。

moco在13年獲取Duke選擇獎，moco的使用也很簡單，維護一份json文件，而後利用命令運行。

在這麼多工具面前，YApi可以脫穎而出實屬不易。在實際工做中，YApi和swagger屬於兩個流派，前者易於管理，有着友好的UI界面，但生態弱，依賴人工和UI維護。而swagger呢，是一個十足的野心家，已經提供api全生命週期的解決方案，它已經不是工具，已然成爲了標準。

3進入YApi

進入YApi後，這頁面，這UI，確實小清新，不愧是後起之秀。這裏簡單進行介紹，它主要有下面四個部分：

首頁頭部展現了當前所在的位置、搜索框、新建項目、查看文檔和用戶信息。

首頁左側展現分組信息，「分組」是「項目」的集合，只有超級管理員能夠管理分組。

首頁右側是分組下的項目和成員列表，點擊左側的某個分組，右側會出現該分組下的項目和成員信息。

點擊項目右上角的星星便可關注項目，關注的項目能夠在「個人關注」頁面查看。

其實不光是首頁UI，他的項目UI也使人咋舌，在UI上這麼清新的國內平臺已經很是少見。

清晰項目佈局

點擊一個項目，進入項目頁，項目頁展現了屬於該項目的所有接口。並提供項目、接口的所有操做。

項目頁左側的 「接口列表」 展現了該項目下的全部接口，右側默認顯示該項目下全部接口的列表。

點擊左側的某個接口，右側會出現「預覽」、「編輯」和「運行」。

點擊左側的 「測試集合」 使用測試集功能。

點擊二級導航的「設置」，項目組長便可編輯項目信息和管理成員列表。

點擊二級導航的「動態」，便可查看項目的操做日誌。

如何開始接口

有的讀者已經火燒眉毛了！下面用一個簡單例子來入門YApi，在項目裏新建接口，這時會彈出一個窗口，幾個選項都很清楚，接口路徑是什麼？這是方便前端調用後端，而設置的接口路徑：

點擊新添加的接口，右側能夠看到接口的預覽信息，點擊右側的編輯進入編輯面板。在該面板中你能夠看到接口的基本信息(接口名稱、分類、路徑)，除此之外，你還能夠完善如下接口信息：

接口路徑：能夠更改 HTTP 請求方式，而且支持 restful 動態路由，例如 /api/{id}/{name}, id和name是動態參數

狀態：用於標識接口是否開發完成。

Tag：用於標識接口tag信息（v1.3.23+）,在接口list頁能夠根據tag過濾接口

咱們接着往下看，你會看到請求參數，能夠設置請求時須要哪些參數，它們能夠是必需，也能夠是沒必要須：

Query參數：接口 url 的查詢字符串。點擊『添加Query參數』按鈕來添加參數，能夠經過拖動來交換參數位置

Headers：http 請求頭字段。在 req_body 形式是 form 格式下會在 header 中自動生成 'Content-Type application/x-www-form-urlencoded'，其餘3種格式也會自動生成不一樣 header

請求參數後面是返回數據，它分爲 json & raw 兩種形式。基於 mockjs 和 json5，這是一種使用註釋的方式寫參數說明，若是你看不懂，請注意下面的連接，這是官網對Mock的介紹。

Mock介紹：

https://hellosean1025.github....

上面只是對接口的設置，但咱們常常遇到一些狀況，好比我想根據不一樣的請求參數、IP返回不一樣的 HTTP Code、HTTP 頭和 JSON 數據，這麼複雜的狀況，接口設置是沒法作到的，指望Mock登場！它說：「大家靠邊站，我能夠作到！」

指望Mock

指望Mock能夠根據設置的請求過濾規則，返回指望數據，這是一個高端玩家。要想使用它，你要先進入接口詳情頁，而後點擊高級Mock。

點擊添加指望，填寫過濾規則以及指望返回數據，以下圖這樣，最後點擊肯定。

咱們在瀏覽器裏測試一下，發送符合規則的請求:

寫在最後

就像文中說的那樣，在這麼多工具面前，YApi可以脫穎而出實屬不易。在實際工做中，YApi和swagger屬於兩個流派。前者易於管理，有着友好的UI界面，但生態弱，依賴人工和UI維護。而swagger呢，是一個十足的野心家，已經提供api全生命週期的解決方案，它已經不是工具，已然成爲了標準。