受新型冠状病毒的影响,在家像猪一样不是睡就是吃,闲着就学着用下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
如果您是将服务器代理到 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+)
首先,找一台可以连接公网的电脑在线安装YApi,在线安装YApi的方法参考文章:Spring Boot 1.5.8集成Swagger2 + YApi —— 部署安装YApi(在线安装)
在线安装完后,指定目录会自动下载一个YApi的工程,将该工程压缩成zip,并通过ftp工具上传到内网服务器上
压缩包拷贝到内网服务器后,解压压缩包,并打开解压后的文件夹,目录如下所示:
删除init.lock文件
修改config.json文件的配置
{
"port": "3001",
"adminAccount": "[email protected]",
"db": {
"servername": "127.0.0.1",
"DATABASE": "yapi",
"port": "27017"
},
"mail": {
"enable": false,
"host": "smtp.163.com",
"port": 465,
"from": "***@163.com",
"auth": {
"user": "***@163.com",
"pass": "*****"
}
}
}
其中port
是项目启动的端口,db
是mongoDB相关的配置,如果要连接的mongoDB开启了访问认证,在db
配置上加上权限认证信息,完整的db
配置如下:
"db": {
"servername": "127.0.0.1",
"DATABASE": "yapi",
"port": 27017,
"user": "test1",
"pass": "test1",
"authSource": ""
}
进入vendors
文件夹,在该文件夹路径下启动命令行,运行命令:
npm run install-server
进入YApi工程根目录,运行命令:
node vendors/server/app.js
提示如下信息表示启动成功:
浏览器打开:http://localhost:3001/
使用 [email protected] / ymfe.org 登陆成功
离线部署成功!