Linux下快速搭建YApi接口管理平台

简介: 目录一、序言二、安装Node1、安装nvm2、使用兼容的Node版本二、安装MongoDB1、下载MongoDB2、配置MongoDB三、安装YApi四、安装PM2管理Node服务五、登录YApi后台

目录

一、序言



为了团队成员更好地合作,准备搭建一个接口管理平台,之前一直用的是YApi,这次自己准备手把手部署一个Yapi实例。YApi是一个前端项目,因为一直做后台开发,所以在部署时踩了一些小坑,特此记录一下。


二、安装Node



Yapi是一个Node项目,在这里遇到了第一个大坑就是版本问题,中间试过Node v16和v14版本,发现都不能用,最后发现安装Node v12版本是可以的。


在这里强烈建议使用nvm来安装Node,nvm是Node的一个版本管理器,可以自由切换Node版本,前端不像后端,不同项目有时适用的Node版本不同,版本不对,心态崩溃。



1、安装nvm

Linux上直接运行安装脚本即可,如下:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
或者
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash


具体地址请参考,nvm安装和更新说明

备注:安装可能有点小慢,耐心等待即可。


2、使用兼容的Node版本

(1) 列出所有可安装的Node版本

nvm ls-remote

(2) 安装适合yapi的Node版本,这里选择v12.22.12

nvm install v12.22.12

(3) 查看当前安装的Node版本

nvm list
->    v12.22.12
       v14.20.0
default -> v12.22.12
iojs -> N/A (default)
unstable -> N/A (default)
node -> stable (-> v14.20.0) (default)
stable -> 14.20 (-> v14.20.0) (default)
lts/* -> lts/gallium (-> N/A)
lts/argon -> v4.9.1 (-> N/A)
lts/boron -> v6.17.1 (-> N/A)
lts/carbon -> v8.17.0 (-> N/A)
lts/dubnium -> v10.24.1 (-> N/A)
lts/erbium -> v12.22.12
lts/fermium -> v14.20.0
lts/gallium -> v16.16.0 (-> N/A)
nvm use default
或者
nvm use v12.22.12
node -v


二、安装MongoDB


1、下载MongoDB

Yapi数据存储选择的是Mongo DB,所以在初始化Yapi前我们先得部署一个Mongo实例。

这里我安装的Mongo DB版本是4.4.15,直接运行以下命令即可:

wget http://downloads.mongodb.org/linux/mongodb-linux-x86_64-rhel70-v4.4-latest.tgz


然后再解压:

tar xzf mongodb-linux-x86_64-rhel70-v4.4-latest.tgz

2、配置MongoDB

(1) MongoDB解压目录下新建相关目录

mkdir conf data logs


备注:conf为配置文件目录,data为数据目录,logs为日志目录。

(2) conf目录下新增配置文件mongod.conf

touch mongod.conf

配置文件内容如下:

systemLog:
   destination: file
   path: "/mongodb-4.4.15/logs/mongodb.log" # 日志目录
   logAppend: true
net:
   bindIp: 127.0.0.1 # 绑定的ip
   port: 27017 # 服务端口
   unixDomainSocket:
      enabled: false # 如果开启,下面的pathPrefix配置得加上,不然会写在/tmp目录下
      pathPrefix: "/mongodb-4.4.15/conf" 
storage:
   dbPath: "/mongodb-4.4.15/data" # 数据目录

(3) 启动Mongo DB

进入到安装MongoDB的bin目录下,运行如下命令即可。

./mongod -f /mongodb-4.4.15/conf/mongod.conf &

(4) 连接测试

直接在bin目录下运行如下命令即可。

./mongo

59101dc718fc44c1aab77d12a8220fe8.png

三、安装YApi


# 安装yapi
npm install -g yapi-cli --registry https://registry.npm.taobao.org
# 启动服务
yapi server 

b13c575a05344685b83b2687a0ff2e9c.png点击开始部署后,会弹出一个界面,里面展示的是应用部署的日志信息,同时shell终端也会出现同样的日志信息。

部署成功后,会提示如何启动服务,执行如下命令即可:

node /yapi/vendors/server/app.js

备注:我的部署路径为/opt/appl/yapi,软链接为yapi -> /opt/appl/yapi,上面这种启动方式为前台启动,按Ctrl + C后服务会终止。关于如何在后台启动Node.js应用,请往后看。

四、安装PM2管理Node服务



PM2Node.js应用的后台进程管理器,内置负载均衡器,可以实现无停机加载,帮助我们更好的管理和维护后台应用。

除了管理Node.js应用,它还能管理其它任何可执行的脚本和二进制文件,如下:

$ pm2 start bashscript.sh
$ pm2 start python-app.py --watch
$ pm2 start binary-file -- --port 1520

(1) 启动yapi服务

pm2 start /yapi/vendors/server/app.js --name yapi --log /yapi/log/yapi.log
  • --name:指定应用名。
  • --log:指定日志文件。

备注:pm2管理的应用会在后台启动。

(2) 查看服务状态

pm2 status

ede63c789b4e4932a4e6404c00e9e266.png

(3) 终止服务

pm2 stop /yapi/vendors/server/app.js

五、登录YApi后台


备注:初始密码可以在个人中心修改。

b58fe75993524e1981a8cea858961852.png

相关文章
|
5月前
|
安全 Linux iOS开发
Binary Ninja 5.1.8104 (macOS, Linux, Windows) - 反编译器、反汇编器、调试器和二进制分析平台
Binary Ninja 5.1.8104 (macOS, Linux, Windows) - 反编译器、反汇编器、调试器和二进制分析平台
524 53
Binary Ninja 5.1.8104 (macOS, Linux, Windows) - 反编译器、反汇编器、调试器和二进制分析平台
|
5月前
|
Linux API iOS开发
Binary Ninja 4.2.6455 (macOS, Linux, Windows) - 反编译器、反汇编器、调试器和二进制分析平台
Binary Ninja 4.2.6455 (macOS, Linux, Windows) - 反编译器、反汇编器、调试器和二进制分析平台
361 14
Binary Ninja 4.2.6455 (macOS, Linux, Windows) - 反编译器、反汇编器、调试器和二进制分析平台
|
6月前
|
SQL Linux 调度
Timeplus Enterprise 3.0 (Linux, macOS) - 流处理平台
Timeplus Enterprise 3.0 (Linux, macOS) - 流处理平台
145 2
Timeplus Enterprise 3.0 (Linux, macOS) - 流处理平台
|
6月前
|
安全 Linux API
JEB Pro v5.31 (macOS, Linux, Windows) - 逆向工程平台
JEB Pro v5.31 (macOS, Linux, Windows) - 逆向工程平台
220 0
|
9月前
|
Ubuntu Linux Shell
Linux环境下VSCode快速安装终极指南:debian/ubuntu/linux平台通用
以上就是在Linux环境下安装VSCode的终极指南,抛开繁复的专业词汇,以平易近人的文字、形象生动的比喻让你轻松学会这一过程。别忘了,你的小伙伴VSCode已经在应用菜单里等你了!
2543 23
|
10月前
|
Java 关系型数据库 MySQL
在Linux平台上进行JDK、Tomcat、MySQL的安装并部署后端项目
现在,你可以通过访问http://Your_IP:Tomcat_Port/Your_Project访问你的项目了。如果一切顺利,你将看到那绚烂的胜利之光照耀在你的项目之上!
492 41
|
10月前
|
安全 前端开发 Linux
Immunity CANVAS Professional 7.27 (macOS, Linux, Windows) - 渗透测试和漏洞利用平台
Immunity CANVAS Professional 7.27 (macOS, Linux, Windows) - 渗透测试和漏洞利用平台
274 3
Immunity CANVAS Professional 7.27 (macOS, Linux, Windows) - 渗透测试和漏洞利用平台
|
Unix Linux iOS开发
Splunk Enterprise 10.0.0 (macOS, Linux, Windows) - 搜索、分析和可视化,数据全面洞察平台
Splunk Enterprise 10.0.0 (macOS, Linux, Windows) - 搜索、分析和可视化,数据全面洞察平台
192 0
|
9月前
|
Dart Linux iOS开发
JEB Pro v5.30 (macOS, Linux, Windows) - 逆向工程平台
JEB Pro v5.30 (macOS, Linux, Windows) - 逆向工程平台
783 0
JEB Pro v5.30 (macOS, Linux, Windows) - 逆向工程平台
|
10月前
|
开发框架 Java 关系型数据库
在Linux系统中安装JDK、Tomcat、MySQL以及部署J2EE后端接口
校验时,浏览器输入:http://[your_server_IP]:8080/myapp。如果你看到你的应用的欢迎页面,恭喜你,一切都已就绪。
624 17