YApi——手摸手,帶你在Win10環境下安裝YApi可視化介面管理平台

手摸手,帶你在Win10環境下安裝YApi可視化介面管理平台

YApi

  YApi 是高效、易用、功能強大的 api 管理平台,旨在為開發、產品、測試人員提供更優雅的介面管理服務。可以幫助開發者輕鬆創建、發布、維護 API,YApi 還為用戶提供了優秀的交互體驗,

開發人員只需利用平台提供的介面數據寫入工具以及簡單的點擊操作就可以實現介面的管理。

一、環境要求

  • nodejs(7.6+)
  • mongodb(2.6+)
  • git

二、安裝Git

  1、Git官網下載://git-scm.com/downloads

  2、直接下一步,下一步安裝。

三、安裝Node

  1、官網下載://nodejs.org/en/download/

  2、下一步下一步下一步安裝

  3、安裝成功後,可查看node版本

1 node -v
2 3 node --version

  4、查看npm版本

1 npm -v

  查看各版本截圖,如下圖所示。

四、安裝MongoDB

  1、官網下載://www.mongodb.com/try/download/community?jmp=nav

  官網下載太慢的話,可以使用下面的鏈接:

    //dl.mongodb.org/dl/win32/x86_64

  2、選擇Custom,一路next

   3、下一步安裝 “install mongoDB compass” 不勾選,否則可能要很長時間都一直在執行安裝,MongoDB Compass 是一個圖形介面管理工具,我們可以在後面自己到官網下載安裝,下載地址:

    //www.mongodb.com/download-center/compass

  4、配置MongoDB,進入MongoDB安裝目錄,進入bin文件夾,複製文件夾路徑,打開控制面板,選擇「系統與安全」——「系統」——「高級系統設置」,點擊環境變數Path,將複製的路徑新建在環境變數裡面。

    MongoDB的安裝路徑一般在:C:\Program Files\MongoDB\Server\4.2\bin

  5、在安裝目錄下\data\創建一個db目錄,作為安裝目錄\data\的備用目錄,可以使用–dbpath””安裝目錄\data\db”顯式指定該目錄為存儲位置,來啟動MongoDB,如:

1 cd C:\Program Files\MongoDB\Server\4.2
2 mongod.exe --dbpath "C:\Program Files\MongoDB\Server\4.2\data\db"

  6、此時MongoDB已經開啟,瀏覽器訪問//localhost:27017/,頁面上會出現如下圖所示。說明MongoDB已經啟動了,且默認埠(27017)沒有被佔用。

五、安裝YApi

  1、前提安裝好Node、Git、MongoDB

  2、採用方式一:可視化部署[推薦]

  3、在D盤下創建yapi空文件夾,利用git工具進行開啟yapi服務。在文件夾空白處滑鼠右擊,會出現「Git Bash Here」,點擊。

  4、安裝yapi,命令如下所示。

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

  成功安裝後,會出現如下截圖。

 

   直接按照提示要求,打開網站//localhost:9090/,填寫公司名稱。

  點擊開始部署,部署完成並成功後,可通過底部提示啟動伺服器。

  我們回到Git Hash終端,最終底部也有相同的提示。如下圖所示。

  直接輸入「node vendors/server/app.js的命令,可看出有throw異常報錯。報錯如下圖所示。

  打開創建項目的文件D:yapi,可發現文件夾下多出一個my-yapi的文件夾。在my-yapi下面才是YApi項目的文件。如下圖所示。

  我們可得知,是我們運行的文件目錄不對,應重新定位文件目錄。我們需要定位目錄至my-yapi文件夾。如下圖所示。

  這樣,我們就可以直接訪問//127.0.0.1:3000/。默認帳號:[email protected]

  默認密碼:ymfe.org。如下圖所示。

六、YApi設置後台運行

利用PM2管理YApi後台運行

  PM2是node進程管理工具,可以利用它來簡化很多node應用管理的繁瑣任務,如性能監控、自動重啟、負載均衡等,而且使用非常簡單。

  1、先全局安裝PM2。打開CMD輸入全局安裝命令。如下所示。

1 npm install -g pm2

  直接安裝可看出經常安裝失敗。我們可利用中國鏡像來安裝,如下圖所示

1 npm install -g pm2 --registry //registry.npm.taobao.org

  安裝成功,如下圖所示。

  2、後台啟動或關閉

  我的YApi的安裝目錄在D:\yapi\my-yapi\。

  啟動執行:

1 pm2 start D:\yapi\my-yapi\vendors\server\app.js

  啟動執行成功,如下所示。

  關閉執行:

1 pm2 stop D:\yapi\my-yapi\vendors\server\app.js

  關閉執行成功,如下所示。

 

參考:

1、YAPI介面管理平台://hellosean1025.github.io/yapi/index.html

2、PM2實用入門指南://imweb.io/topic/57c8cbb27f226f687b365636

3、MongoDB安裝與配置://www.cnblogs.com/wjaaron/p/7800490.html

4、api管理工具-Yapi的搭建-windows篇