官方文档:https://hellosean1025.github.io/yapi/devops/index.html#%E5%AE%89%E8%A3%85
一:本地开发(可视化部署)
npm install -g yapi-cli --registry https://registry.npm.taobao.org # 报错的话需要加上sudo yapi server
打开浏览器,一般是127.0.0.1:9090进行配置。等待配置完成之后,根据页面提示。
执行成功后
依赖库安装完成,正在初始化数据库mongodb...
> yapi-vendor@1.9.2 install-server /software/my-yapi/vendors > node server/install.js
log: mongodb load success...
初始化管理员账号成功,账号名:"admin@admin",密码:"ymfe.org"
部署成功,请切换到部署目录,输入: "node vendors/server/app.js" 指令启动服务器, 然后在浏览器打开 http://127.0.0.1:3000 访问
注意:
1、如何至内网无网络情况部署
本地部署完,即可以使用,想要部署到内网无网络情况。可以直接将my-yapi整个文件夹拷贝到内网服务器上,并且将本地mongodb的yapi整个数据导入至内网服务器中。此时依旧开启服务。依旧可用
官网介绍的很详细:https://yapi.ymfe.org/devops/index.html # 此处直接贴官网内容
mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors //或者下载 zip 包解压到 vendors 目录(clone 整个仓库大概 140+ M,可以通过 `git clone --depth=1 https://github.com/YMFE/yapi.git vendors` 命令减少,大概 10+ M)
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
cd vendors
npm install --production --registry https://registry.npm.taobao.org
npm run install-server //安装程序会初始化数据库索引和管理员账号,管理员账号名可在 config.json 配置
node server/app.js //启动服务器后,请访问 127.0.0.1:{config.json配置的端口},初次运行会有个编译的过程,请耐心等候
启动
按照官网上面的方式来启动,但是这里的启动方式是前台启动,当你关闭ssh窗口的时候,程序也就随之关闭了,所以需要改为后台运行,这里可以使用pm2进行管理。
pm2安装
npm install -g pm2
后台启动,关闭
我的yapi是安装在/usr/local/my-yapi
启动执行: pm2 start /usr/local/my-yapi/vendors/server/app.js
关闭执行: pm2 stop /usr/local/my-yapi/vendors/server/app.js
这样以后就可以很方便的用pm2就行启动关闭