YApi——手摸手，帶你在Win10環境下安裝YApi可視化接口管理平臺

手摸手，帶你在Win10環境下安裝YApi可視化接口管理平臺

YApi

　　YApi 是高效、易用、功能強大的 api 管理平臺，旨在爲開發、產品、測試人員提供更優雅的接口管理服務。能夠幫助開發者輕鬆建立、發佈、維護 API，YApi 還爲用戶提供了優秀的交互體驗，

開發人員只需利用平臺提供的接口數據寫入工具以及簡單的點擊操做就能夠實現接口的管理。

1、環境要求

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

2、安裝Git

　　一、Git官網下載：https://git-scm.com/downloads

　　二、直接下一步，下一步安裝。

3、安裝Node

　　一、官網下載：https://nodejs.org/en/download/

　　二、下一步下一步下一步安裝

　　三、安裝成功後，可查看node版本

1 node -v
2 或
3 node --version

　　四、查看npm版本

1 npm -v

　　查看各版本截圖，以下圖所示。

4、安裝MongoDB

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

　　官網下載太慢的話，可使用下面的連接：

　　　　http://dl.mongodb.org/dl/win32/x86_64

　　二、選擇Custom，一路next

 　　三、下一步安裝 "install mongoDB compass" 不勾選，不然可能要很長時間都一直在執行安裝，MongoDB Compass 是一個圖形界面管理工具，咱們能夠在後面本身到官網下載安裝，下載地址：

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

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

　　　　MongoDB的安裝路徑通常在：C:\Program Files\MongoDB\Server\4.2\bin

　　五、在安裝目錄下\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"

　　六、此時MongoDB已經開啓，瀏覽器訪問http://localhost:27017/，頁面上會出現以下圖所示。說明MongoDB已經啓動了，且默認端口（27017）沒有被佔用。

5、安裝YApi

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

　　二、採用方式一：可視化部署[推薦]

　　三、在D盤下建立yapi空文件夾，利用git工具進行開啓yapi服務。在文件夾空白處鼠標右擊，會出現「Git Bash Here」，點擊。

　　四、安裝yapi，命令以下所示。

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

　　成功安裝後，會出現以下截圖。

 

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

　　點擊開始部署，部署完成併成功後，可經過底部提示啓動服務器。

　　咱們回到Git Hash終端，最終底部也有相同的提示。以下圖所示。

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

　　打開建立項目的文件D：yapi，可發現文件夾下多出一個my-yapi的文件夾。在my-yapi下面纔是YApi項目的文件。以下圖所示。

　　咱們可得知，是咱們運行的文件目錄不對，應從新定位文件目錄。咱們須要定位目錄至my-yapi文件夾。以下圖所示。

　　這樣，咱們就能夠直接訪問http://127.0.0.1:3000/。默認賬號：admin@admin.com

　　默認密碼：ymfe.org。以下圖所示。

6、YApi設置後臺運行

利用PM2管理YApi後臺運行

　　PM2是node進程管理工具，能夠利用它來簡化不少node應用管理的繁瑣任務，如性能監控、自動重啓、負載均衡等，並且使用很是簡單。

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

1 npm install -g pm2

　　直接安裝可看出常常安裝失敗。咱們可利用國內鏡像來安裝，以下圖所示

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

　　安裝成功，以下圖所示。

　　二、後臺啓動或關閉

　　個人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

　　關閉執行成功，以下所示。

 

參考：

一、YAPI接口管理平臺：https://hellosean1025.github.io/yapi/index.html

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

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

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