一準備工具

• Mongodb

• Node和npm

二文件地址

https://hellosean1025.github.io/yapi/

三安裝步驟

1.安裝Mongodb，請參考

2.安裝Node,請參考

3.安裝YApi

1）YApi介紹

旨在為開發、產品、測試人員提供更優雅的介面管理服務。可以幫助開發者輕鬆建立、釋出、維護 API。以及自動化生成介面文件。

2）本地開發(視覺化部署) 有網路要求的情況下

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

3.執行yapi的配置服務

yapi server

4.

完成提示瀏覽器開啟127.0.0.1:9090進行yapi配置。等待配置完成之後，根據頁面提示。

5.啟動yapi服務

根據提示在yapi本地安裝路徑下找到D:\file\install\yapi\vendors\server\目錄下,此目錄下開啟cmd 輸入命令

nodeapp.js

根據提示開啟127.0.0.1:3000即可使用。（3000埠儘量留給它）

6.使用pm2進行服務管理

如果使用node vendors/server/app.js啟動Yapi服務的話，如果我們把cmd視窗關閉了，這時候我們就無法訪問Yapi了，這時候我們就可以使用 pm2 管理 node 伺服器啟動，停止

1：安裝pm2

npm i -g pm2

2：pm2管理yapi服務

進入Yapi的部署目錄執行

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

如下表示成功：

這時候我們就可以使用pm2來管理yapi了

pm2操作Yapi基本命令：

   pm2 info yapi //檢視服務資訊

   pm2 start yapi //啟動服務

   pm2 stop yapi //停止服務

   pm2 restart yapi //重啟服務

   pm2 delete yapi //刪除服務

pm2使用參考：https://blog.csdn.net/dreamer2020/article/details/53576382

7.預設賬戶密碼

賬號：[email protected]（配置時修改的賬號）

密碼：ymfe.org

五IDEA整合YapiUpload介面管理配置

1.外掛裡搜尋下載YapiUpload

首先開啟idea介面，然後 按住快捷鍵ctrl+shift+a然後輸入plugins,這個是外掛安裝的意思，然後我們選擇這個plugins然後回車進入外掛安裝介面。搜尋YapiUpload，並按照YapiUpload

2.在專案中的.idea檔案中，找到misc.xml檔案

3.開啟misc.xml檔案，在程式碼中新增如下配置

<!--yapi配置-->
<component name="yapi">
    <option name="projectToken">你的YApi對應專案的token</option>
    <option name="projectId">你的YApi對應專案的專案Id</option>
    <option name="yapiUrl">YApi的url</option>
    <option name="projectType">專案型別</option>
</component>

1) projectToken：來源，如下圖

2) projectId：來源，如下圖

3) yapiUrl：專案部署的ip加埠，我的是http://127.0.0.1:3000/

4)測試上傳介面，如下圖，選中方法名，點選右鍵，選擇UploadToYapi,執行之後，上傳介面

介面上傳成功日誌

上傳成功之後，在該專案下，可以看到已經生成的介面可以了