前言
受新型冠狀病毒的影響,在家像豬一樣不是睡就是吃,閒着就學着用下Swagger和YApi,特將這幾天的學習成果寫成了這系列的文章,希望能對大家有所幫助。武漢加油,中國加油!
Spring Boot 1.5.8集成Swagger2 + YApi —— 集成Swagger2
Spring Boot 1.5.8集成Swagger2 + YApi —— Swagger常用註解說明
Spring Boot 1.5.8集成Swagger2 + YApi —— 部署安裝mongoDB
Spring Boot 1.5.8集成Swagger2 + YApi —— 部署安裝YApi(在線安裝)
Spring Boot 1.5.8集成Swagger2 + YApi —— 部署安裝YApi(離線安裝)
Spring Boot 1.5.8集成Swagger2 + YApi —— swagger接口信息導入YApi
YApi官方提供了兩種內網部署YApi的方法,一種是可視化部署,另外一種是命令行部署
官方說明文檔:
https://hellosean1025.github.io/yapi/devops/index.html
nginx配置
如果您是將服務器代理到 nginx 服務器,請配置 nginx 支持 websocket:
在location /添加
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection “upgrade”;
環境要求
- nodejs(7.6+)
- mongodb(2.6+)
安裝步驟
官方文檔寫的比較簡潔,筆者參照第一種可視化部署的方式部署成功了,下面分享下步驟:
1,全局安裝 yapi-cli
直接命令行安裝,安裝命令:
npm install -g yapi-cli --registry https://registry.npm.taobao.org
2,啓動在線安裝的可視化頁面
打開命令窗口,將當前路徑切換到你想存放YApi工程的路徑(比如切換到D:\nodeProgram
路徑,YApi安裝成功後將會在D:\nodeProgram
路徑下創建一個名爲my-yapi
的目錄存放YApi工程)
運行yapi server
啓動可視化在線安裝頁面,命令行提示如下信息:
打開瀏覽器,訪問:http://localhost:9090/
3,自定義配置,開始部署
各項配置說明如下:
自動在線安裝ing…安裝需要一定的時間,我花了5分鐘左右,跟網速有關,請耐心等待
最後提示如下信息,表示YApi已經安裝成功了
4,啓動YApi
命令行切換到剛配置的部署路徑,筆者是D:\nodeProgram\my-yapi
運行如下指令:
node vendors/server/app.js
按照提示,訪問如下鏈接:
http://127.0.0.1:3000/
5,登陸YApi
登陸的賬號密碼在安裝完成的時候有信息提示:
通過 [email protected] / ymfe.org 即可登陸YApi平臺