接口管理平台Yapi

1、介紹

YApi 是由去哪兒移動架構組推出的一款開源項目，是高效、易用、功能強大的 api 管理平台，旨在為開發、產品、測試人員提供更優雅的接口管理服務。

 

官網：https://yapi.ymfe.org/

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

文檔：https://hellosean1025.github.io/yapi/documents/index.html

 

特性：

• 權限管理　　
  • 扁平化權限設計，即保證了大型企業級項目的管理，又保證了易用性
• Mock server
  • 基於 websocket 的多人協作接口編輯功能和類 postman 測試工具，讓多人協作成倍提升開發效率　　
• 數據導入
  • 接口支持導入 swagger, postman, har 數據格式，方便遷移舊項目　　
• 可視化接口
  • 基於 websocket 的多人協作接口編輯功能和類 postman 測試工具，讓多人協作成倍提升開發效率　　
• 自動化測試
  • 完善的接口自動化測試，保證數據的正確性，支持對 Response 斷言　　
• 插件機制
  • 強大的插件機制，滿足各類業務需求　　

 

2、安裝

https://hellosean1025.github.io/yapi/devops/index.html#%E5%AE%89%E8%A3%85

環境要求

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

 

windows

環境

1、安裝node.js
　　https://www.runoob.com/nodejs/nodejs-install-setup.html

2、安裝MongoDB
　　https://www.runoob.com/mongodb/mongodb-window-install.html

3、安裝git
　　https://www.runoob.com/git/git-install-setup.html

4、執行

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

進入可視化安裝頁面
http://127.0.0.1:9000

 

 

修改公司名稱和郵箱地址，點擊開始部署

執行 node vendors/server/app.js

提示安裝完成
訪問 http://127.0.0.1:3000

用戶登陸：輸入您剛才設置的管理員郵箱，默認密碼(ymfe.org) 登錄系統（默認密碼可在個人中心修改）。　

 

Linux搭建

https://www.jianshu.com/p/5bda5556c149

 

安裝出現：

 

解決：

chown -R root:root /nodejs安裝目錄

 

https://www.cnblogs.com/smartrui/p/10767727.html

 

服務器管理

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

官網推薦使用 pm2 管理 node 服務器啟動，停止，具體使用方法可參考下面的教程：

• pm2官方文檔：http://pm2.keymetrics.io/docs/usage/quick-start/#list-managed-applications
• PM2使用入門指南：https://imweb.io/topic/57c8cbb27f226f687b365636

安裝

 

npm install pm2@latest -g

 

執行

切換到yapi的vendors目錄 執行pm2 start

 

pm2 start server/app.js --watch

 

pm2 watch 無限啟動問題解決：

問題：服務一直沒啟動，重啟次數一直在增加，查看log顯示因為日志變更導致

 

 解決方案：

// 生成啟動配置文件
pm2 ecosystem

添加

apps: [
 
  {
    name: "wcpstoreServer",
    script: "app.js",
    //輸出console.error以及console.log
    error_file: "pm2logs/err.log",
    out_file: "pm2logs/out.log",
    log_date_format: "YYYY-MM-DD HH:mm:ss:S Z",
    max_memory_restart : "500M",
    ignore_watch : "logs"、　　//添加這個參數，忽略監聽logs文件夾
}
]

pm2 stop 0　　// 停止之前啟動的服務

pm2 start ecosystem.config.js　　// 啟動

pm2 list　　// 查看服務列表

 

手冊：http://pm2.keymetrics.io/docs/usage/application-declaration/#generate-configuration

 Linux安裝

 docker安裝：https://www.cnblogs.com/qgc1995/p/9549896.html