开源的api接口管理平台--YApi部署过程

本文详细介绍了如何在服务器上部署YAPI,包括安装git、node、mongoDB,通过可视化或命令行方式部署,并使用pm2进行进程管理。提供了每一步的命令行操作和注意事项,如端口修改、禁止注册设置,确保顺利部署和管理YAPI接口文档管理系统。
摘要由CSDN通过智能技术生成

1、安装git

yum install git

2、安装node

附上自己找的解决官方命令不能安装node的解决方法,注意node版本安装7.6+:这里这里

3、安装mongoDB

附上自己参考安装的链接:这里这里

4、参考官网开始安装

官网内网部署教程
方式一. 可视化部署[推荐]
执行 yapi server 启动可视化部署程序,输入相应的配置和点击开始部署,就能完成整个网站的部署。部署完成之后,可按照提示信息,执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱,默认密码(ymfe.org) 登录系统(默认密码可在个人中心修改)。

npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
  • 执行完yapi server后,按提示在浏览器打开指定ip端口,然后就会出现下面的页面,自己配置就好。
  • 如果MongoDB没做认证,最后那个数据库认证就默认关闭状态即可
  • 远程服务器部署在本地浏览器输入服务器公网ip+端口就好,默认启动端口是9090
    在这里插入图片描述
    在这里插入图片描述
    安装完后启动:
node 安装路径/vender/server/app.js

方式二. 命令行部署,这个我没试过
如果 github 压缩文件无法下载,或需要部署到一些特殊的服务器,可尝试此方法

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配置的端口},初次运行会有个编译的过程,请耐心等候
  • 端口修改与禁止注册设置
cd 安装目录下
# 编辑config.json
vim config.json
{
  "port": "要修改的端口,注意是有双引号的",
  "closeRegister":true  # 添加这个字段并设置为true,重启即可禁用注册
}
  • 其他配置参考官网吧

5、使用pm2管理平台启动

贴上官网给的链接:

安装pm2

npm install -g pm2

启动项目

# 使用-n参数自定义项目名,用于后续管理
pm2 start 安装路径/vender/server/app.js -n yapi
# 其他操作
# 查看进程状态
pm2 list
# 停止进程
pm2 stop 自定义项目名
# 重启进程
pm2 restart 自定义项目名

# 不指定的话还是使用:安装路径/vender/server/app.js

启动完后正常访问,配合nginx的话参考附上的链接

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值