介面管理工具YApi怎麼用？顏值高、易管理、超好用
眾多介面管理工具如雨後春筍搬冒出。讓人欣慰的是，有許多優秀作品來自國內，包含YApi和rap。
看著中文的官網，熟悉的漢語，不禁讓人暗爽。當然這也就帶來另一個弊端，因為使用基數少，所以參考資料少。我們想學習使用方法，只能依賴官方文件，也算是福禍相倚了。
本文將帶您走進Yapi的世界，讓您體驗一回小清新的介面管理工具。
根據統計，市面上網際網路專案超過10億，保守統計涉及的API數量有100億。但是很多API的質量堪憂。因為與API相關的文件、除錯、測試和資料Mock在工作中效率非常低。
我們急需一款產品，它需要具有介面管理功能，提供除錯，文件管理和測試功能。這時YApi橫空出世。
這是一個介面管理平臺，可以幫助開發者建立、釋出和維護API。YApi 還為使用者提供了優秀的互動體驗。開發人員只需利用平臺提供的介面資料寫入工具以及簡單的點選操作就可以實現介面的管理。
YApi適合公司業務比較複雜，尤其是跨部門協作的情況下使用，和它類似的工具還有rap、swagger、moco。
rap也具有圖形介面，但火爆程度逐漸不如yapi。而swagger呢，是一個超級強大的工具，它的野心已經不滿足於介面管理，後續課程會講到它。
moco在13年獲取Duke選擇獎，moco的使用也很簡單，維護一份json檔案，然後利用命令執行。
在這麼多工具面前，YApi能夠脫穎而出實屬不易。在實際工作中，YApi和swagger屬於兩個流派，前者易於管理，有著友好的UI介面，但生態弱，依賴人工和UI維護。而swagger呢，是一個十足的野心家，已經提供api全生命週期的解決方案，它已經不是工具，已然成為了標準。
進入YApi後，這頁面，這UI，確實小清新，不愧是後起之秀。這裡簡單進行介紹，它主要有下面四個部分：
1.首頁頭部展示了當前所在的位置、搜尋框、新建專案、檢視文件和使用者資訊。
2.首頁左側展示分組資訊，“分組”是“專案”的集合，只有超級管理員可以管理分組。
3.首頁右側是分組下的專案和成員列表，點選左側的某個分組，右側會出現該分組下的專案和成員資訊。
4.點選專案右上角的星星即可關注專案，關注的專案可以在“我的關注”頁面檢視。
其實不光是首頁UI，他的專案UI也令人咋舌，在UI上這麼清新的國內平臺已經非常少見。
點選一個專案，進入專案頁，專案頁展示了屬於該專案的全部介面。並提供專案、介面的全部操作。
5.專案頁左側的 “介面列表” 展示了該專案下的所有介面，右側預設顯示該專案下所有介面的列表。
6.點選左側的某個介面，右側會出現“預覽”、“編輯”和“執行”。
7.點選左側的 “測試集合” 使用測試集功能。
8.點選二級導航的“設定”，專案組長即可編輯專案資訊和管理成員列表。
9.點選二級導航的“動態”，即可檢視專案的操作日誌。
有的讀者已經迫不及待了！下面用一個簡單例子來入門YApi，在專案裡新建介面，這時會彈出一個視窗，幾個選項都很清楚，介面路徑是什麼？這是方便前端呼叫後端，而設定的介面路徑：
1080×472 49.4 KB
點選新新增的介面，右側可以看到介面的預覽資訊，點選右側的編輯進入編輯面板。在該面板中你可以看到介面的基本資訊(介面名稱、分類、路徑)，除此以外，你還可以完善以下介面資訊：
- 介面路徑：可以更改 HTTP 請求方式，並且支援 restful 動態路由，例如 /api/{id}/{name}, id和name是動態引數
- 狀態：用於標識介面是否開發完成。
- Tag：用於標識介面tag資訊（v1.3.23+）,在介面list頁可以根據tag過濾介面
1014×470 22.9 KB
我們接著往下看，你會看到請求引數，可以設定請求時需要哪些引數，它們可以是必需，也可以是不必須： - Query引數：介面 url 的查詢字串。點選『新增Query引數』按鈕來新增引數，可以通過拖動來交換引數位置
- Headers：http 請求頭欄位。在 req_body 形式是 form 格式下會在 header 中自動生成 ‘Content-Type application/x-www-form-urlencoded’，其他3種格式也會自動生成不同 header
1080×290 23.1 KB
請求引數後面是返回資料，它分為 json & raw 兩種形式。基於 mockjs 和 json5，這是一種使用註釋的方式寫引數說明，如果你看不懂，請注意下面的連結，這是官網對Mock的介紹。
Mock介紹：
Mock介紹-教程
853×436 22.8 KB
上面只是對介面的設定，但我們經常遇到一些情況，比如我想根據不同的請求引數、IP返回不同的 HTTP Code、HTTP 頭和 JSON 資料，這麼複雜的情況，介面設定是無法做到的，期望Mock登場！它說：“你們靠邊站，我可以做到！”
期望Mock可以根據設定的請求過濾規則，返回期望資料，這是一個高階玩家。要想使用它，你要先進入介面詳情頁，然後點選高階Mock。
1080×286 34.1 KB
點選新增期望，填寫過濾規則以及期望返回資料，如下圖這樣，最後點選確定。
1080×872 34.9 KB 845×659 23.1 KB
我們在瀏覽器裡測試一下，傳送符合規則的請求:
950×647 65.4 KB
就像文中說的那樣，在這麼多工具面前，YApi能夠脫穎而出實屬不易。在實際工作中，YApi和swagger屬於兩個流派。前者易於管理，有著友好的UI介面，但生態弱，依賴人工和UI維護。而swagger呢，是一個十足的野心家，已經提供api全生命週期的解決方案，它已經不是工具，已然成為了標準。
YApi要走的路還很長，它有自己勁敵：swagger。由於篇幅有限，本篇文章暫時講解到此，更多精彩內容請關注霍格沃茲測試學院公眾號。