windows環境下yapi內網部署詳細步驟

本文主要針對yapi進行介紹，以及如何在內網部署yapi，當然yapi也支持官網在線使用，根據自己的需求可以酌情選擇。

• 什么是yapi？
• 為什么需要yapi？
• 如何在內網部署yapi？

一、什么是Yapi？

YApi 是高效、易用、功能強大的 api 管理平台，旨在為開發、產品、測試人員提供更優雅的接口管理服務。可以幫助開發者輕松創建、發布、維護 API，YApi 還為用戶提供了優秀的交互體驗，開發人員只需利用平台提供的接口數據寫入工具以及簡單的點擊操作就可以實現接口的管理。

特性：

• 基於 Json5 和 Mockjs 定義接口返回數據的結構和文檔，效率提升多倍
• 扁平化權限設計，即保證了大型企業級項目的管理，又保證了易用性
• 類似 postman 的接口調試
• 自動化測試, 支持對 Response 斷言
• MockServer 除支持普通的隨機 mock 外，還增加了 Mock 期望功能，根據設置的請求過濾規則，返回期望數據
• 支持 postman, har, swagger 數據導入
• 免費開源，內網部署，接口信息更安全

 

二、為什么需要Yapi？

業務痛點：后端程序員開發接口的同時還要編寫接口對應的文檔，這是一件繁瑣且耗時的工程。前端工程師為了處理各種數據異常情況，將會寫大量異常處理邏輯，同時對於前端程序員，在后端功能沒有開發完成之前，他們需要接口返回數據 Mock ，以便不影響開發進度。傳統的數據 mock 是把模擬數據寫到項目代碼里，這么做會帶來更多新的問題，首先后端程序員定義的接口隨着需求、架構涉及隨時發生變化的，如果前端程序員完全按照最初的設計定義mock數據，將會和實際做出來的接口有很大的出入。

解決方案：

• YApi 將接口文檔和測試通過單一數據源連接到一起，如果有改動，因為改的是單一的數據源，因此不會出現更新滯后和不及時問題。
• 在 YApi 中，后端既可以定義接口參數和返回值，也可以制定mock數據源，在后端開發過程中，可以隨時調整接口定義，並通知給前端開發者改動信息，前后端只要維護接口定義的響應數據，就可以生成需要的模擬數據。
• YApi 提供了期望和自定義腳本的功能。
• YApi 提供 GUI 界面，只需配置相關的參數和斷言語句，就能實現自動化測試，同時也提供了強大的 Pre-Script 和可視化表達式功能。
• YApi提供了靈活強大的插件機制滿足各類業務的需求。目前YApi的第三方登錄，swagger、postman 數據導入等功能都是基於插件機制實現。

 

三、如何在內網部署Yapi？

環境要求：

• nodejs（7.6+)
• mongodb（2.6+）

3.1 安裝

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

3.2 運行

yapi server

運行成功后，在瀏覽器中訪問以下地址：http://127.0.0.1:9090，在以下頁面中填寫項目相關信息

3.3 安裝pm2來管理yapi服務

PM2（Process Manager 2 ）是具有內置負載均衡器的Node.js應用程序的生產運行時和進程管理器。 它允許您永久保持應用程序活躍，無需停機即可重新加載它們，並促進常見的Devops任務。

3.3.1 安裝pm2

npm install pm2 -g

3.3.2 進入項目目錄

cd /d E:\myyapi

3.3.3 利用pm2啟動yapi服務（名稱根據實際情況自定義）

pm2 start "vendors/server/app.js" --name yapi

備注常用的pm2命令：

// 查看服務信息
pm2 info yapi
// 停止服務
pm2 stop yapi
// 重啟服務
pm2 restart yapi

按照以上步驟部署完成后，在瀏覽器中訪問：http://127.0.0.1:3000/login，賬號：上面3.2步驟中設置的管理員郵箱；默認密碼：ymfe.org（默認密碼可以在個人中心進行修改）

 

 至此，內網部署Yapi就已經完成了，yapi的使用比較簡單，這里不做詳細介紹，有興趣的進去操作下就能快速上手。