Yapi部署指南

小蓝 • 2024-12-12 17:11 • 编程

Yapi是一个基于Node.js的、可本地部署的、信息管理系统，它的主要作用是帮助团队协作完成接口管理、文档管理等工作，提高接口开发效率，实现前后端联调。

部署Yapi需要准备好以下软件和环境：

1、Node.js和npm

2、MongoDB

3、nginx或apache

4、pm2

下面我们来逐步操作实现Yapi部署。

MongoDB是一个免费的开源数据库，它舍弃了传统的关系型数据库的表结构，而是采用了文档数据模型存储数据。Yapi需要使用MongoDB存储数据，因此需要先安装并配置MongoDB。

1、安装MongoDB

$ sudo apt-get install mongodb

2、配置MongoDB

首先，在 /etc/mongodb.conf 文件中配置 MongoDB 的监听地址。默认情况下 MongoDB 监听在 127.0.0.1:27017，如果想创建一个只监听了 192.168.100.100:27017 的 MongoDB 实例，可以进行以下配置：

bind_ip = 192.168.100.100
port = 27017

3、启动MongoDB

$ sudo service mongodb start

启动成功后，可以查看 MongoDB 的状态：

$ sudo service mongodb status

1、安装Yapi

全局安装 Yapi 并配置数据库信息和管理员账号：

$ npm install -g yapi-cli --registry https://registry.npm.taobao.org

2、初始化Yapi

在 Yapi 的根目录运行初始化命令，按照提示填写基本信息和数据库配置信息即可。接着运行以下命令：

$ yapi server

3、配置日志输出到log文件中

$ yapi server > server.log 2>&1 &

在 /etc/profile 文件中添加环境变量：

export YAPI_HOME=/data/yapi/

在 /etc/bashrc 文件中添加：

source /etc/profile

1、安装nginx或apache

在Ubuntu 16.04中安装nginx：

$ sudo apt-get update
$ sudo apt-get install nginx

2、配置nginx

在 /etc/nginx/sites-available/default 文件中配置反向代理信息：

location /yapi {
    proxy_pass http://127.0.0.1:3000;
}

3、重启nginx服务

sudo service nginx restart

1、全局安装pm2

$ npm install -g pm2

2、启动Yapi

$ pm2 start /usr/local/lib/node_modules/yapi/app.js --watch --name yapi

3、保存配置信息

$ pm2 save

4、设置开机启动

在 /etc/rc.local 文件的末尾添加以下命令：

su - yapi -c "pm2 start /usr/local/lib/node_modules/yapi/app.js --watch --name yapi"

这样在每次服务器重启后，pm2 会自动启动 Yapi。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/249683.html