在多產品開發中，往往有多個專案和多個應用服務需要進行管理，尤其在前後端分離和微服務化的開發場景下，API 介面數量眾多，且分屬專案和開發人員不同，為協作開發和專案管理帶來了不少困難，一個易用的 API 管理平臺成為產品開發過程中必不可少的工具。YApi 作為一個高效、易用，且功能強大的 API 管理平臺，提供了視覺化的圖形介面，使得開發人員可以輕鬆管理不同的開發專案、介面文件和介面維護，大大提高了開發效率。

簡介

YApi，是 YMFE 在 Github 上開源的視覺化介面管理平臺，專案位於 https://github.com/YMFE/yapi，目前版本為 v1.9.2。 YApi 是高效、易用、功能強大的 API 管理平臺，旨在為開發、產品、測試人員提供更優雅的介面管理服務。可以幫助開發者輕鬆建立、釋出、維護 API，YApi 還為使用者提供了優秀的互動體驗，開發人員只需利用平臺提供的介面資料寫入工具以及簡單的點選操作就可以實現介面的管理。

安裝

YApi 使用 Node.js 開發，在本地部署，環境要求：Node.js 7.6+，MongoDB 2.6+，Git，可以使用專案提供的 yapi-cli 工具進行安裝部署：

npm install -g yapi-cli --registry https://registry.npm.taobao.orgyapi server 

輸入相應的配置和點選開始部署，就能完成整個網站的部署。部署完成之後，可按照提示資訊，執行 node/{網站路徑/server/app.js} 啟動伺服器。在瀏覽器開啟指定 url, 點選登入輸入剛才設定的管理員郵箱，預設密碼為 ymfe.org 來登入系統（預設密碼可在個人中心修改）。

YApi 使用 pm2 管理和維護服務：

npm install pm2 -g //安裝pm2cd {專案目錄}pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服務pm2 info yapi //檢視服務資訊pm2 stop yapi //停止服務pm2 restart yapi //重啟服務

YApi 的版本升級也十分方便，不會影響已有的專案資料：

cd {專案目錄}yapi ls //檢視版本號列表yapi update //更新到最新版本yapi update -v {Version} //更新到指定版本

示例

YApi 使用簡單，可以在內網部署，以供開發團隊使用。部署完成後，團隊成員註冊賬號後登入，進入首頁，首頁展示了分組與專案。可以搜尋、瀏覽 “公開專案” 的介面，如果在首頁找不到任何專案，請聯絡管理員將你加入對應專案。

首頁頭部展示了當前所在的位置、搜尋框、新建專案、檢視文件和使用者資訊。首頁左側展示分組資訊，“分組”是“專案”的集合，只有超級管理員可以管理分組。首頁右側是分組下的專案和成員列表，點選左側的某個分組，右側會出現該分組下的專案和成員資訊。點選專案右上角的星星即可關注專案，關注的專案可以在“我的關注”頁面檢視。

YApi首頁

專案頁左側的 “介面列表” 展示了該專案下的所有介面，右側預設顯示該專案下所有介面的列表。點選左側的某個介面，右側會出現“預覽”、“編輯”和“執行”。點選左側的 “測試集合” 使用測試集功能。點選二級導航的“設定”，專案組長即可編輯專案資訊和管理成員列表。點選二級導航的“動態”，即可檢視專案的操作日誌。

YApi專案

YApi使用者中心

YApi 管理介面十分簡單，可以在專案中新增介面。點選一個專案，進入該專案的詳情頁。點選左側介面分組右側的選單按鈕，選擇 新增介面，或者點選介面列表右上角的 新增介面。

新增介面

至此，就建立了一個 YApi 的介面，可以看到在左側看到介面名稱，右側有該介面的資訊預覽。

對於介面，可以配置 Mock 介面，使用 JSON Schema 定義介面測試資料和響應，即可完成一個 Mock 介面的部署，可以利用該介面進行測試開發。

總結

YApi 作為一個介面管理平臺，其上手簡單、功能強大，降低了介面眾多、管理混亂帶來的額外時間消耗，大大提高開發專案的管理效率。目前，YApi 已被廣泛應用，成為專案管理的重要基礎工具之一，十分值得在實踐中應用。