一准備工具
-
Mongodb
-
Node和npm
二文檔地址
https://hellosean1025.github.io/yapi/
三安裝步驟
1.安裝Mongodb，請參考
https://www.cnblogs.com/a876459952/articles/13260439.html
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 輸入命令
node app.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.默認賬戶密碼
賬號：admin@admin.com（配置時修改的賬號）
密碼：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,執行之后，上傳接口
接口上傳成功日志
上傳成功之后，在該項目下，可以看到已經生成的接口可以了
