前言
受新型冠状病毒的影响,在家像猪一样不是睡就是吃,闲着就学着用下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
登陆的账号密码在安装完成的时候有信息提示:
通过 admin@admin.com / ymfe.org 即可登陆YApi平台