centos部署YApi – 大雄的家

1. 环境准备

1.1 安装 Node.js 和 npm

建议使用 nvm 来管理 Node.js 版本。操作步骤如下：

安装 nvm：
打开终端，执行：

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash

安装完成后，重启终端或执行下面的命令加载 nvm（根据你的 shell 类型选择对应的配置文件）：

source ~/.bashrc
# 或者如果你使用 zsh：
source ~/.zshrc

安装 Node.js（建议 v14 或更高版本）：

nvm install 14
nvm use 14
#切换阿里云镜像
npm config set registry https://registry.npmmirror.com

验证安装：

node -v
npm -v

1.2 安装 MongoDB

YApi 使用 MongoDB 作为数据存储。由于 CentOS 9 尚未直接支持 MongoDB 官方仓库，因此可以使用 CentOS 8 的官方仓库安装 MongoDB Community 6.0 版（大部分情况下在 CentOS 9 上也可正常运行）。

添加 MongoDB 仓库：

以 root 用户或使用 sudo 创建仓库文件 /etc/yum.repos.d/mongodb-org-6.0.repo：

sudo vi /etc/yum.repos.d/mongodb-org-6.0.repo

将以下内容粘贴到文件中（注意 baseurl 中使用的是 redhat/8）：

[mongodb-org-6.0]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/8/mongodb-org/6.0/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-6.0.asc

保存并退出编辑器。

安装 MongoDB：

sudo dnf install -y mongodb-org

启动 MongoDB 并设置开机自启：

sudo systemctl start mongod
sudo systemctl enable mongod

检查 MongoDB 状态：

sudo systemctl status mongod

确保 MongoDB 正常启动并监听默认端口 27017。

2. 下载 YApi 源码

选择合适的目录，在终端中执行以下命令：

git clone --depth=1 https://github.com/YMFE/yapi.git vendors
cd yapi

3. 安装 YApi 依赖

在 YApi 项目根目录下执行：

npm install

提示：
如果在国内下载依赖较慢，建议先全局安装 cnpm：

npm install -g cnpm --registry=https://registry.npmmirror.com

然后使用：

cnpm install

4. 配置 YApi

YApi 的配置文件通常位于项目根目录下的 config.json（或在部分版本的 config 目录中）。请根据实际情况修改配置，下面给出一个基础示例：

[root@VM-1-12-tencentos yapi]# cat config.json 
{
  "port": "3000",
  "adminAccount": "admin@admin.com",
  "timeout":120000,
  "db": {
    "servername": "127.0.0.1",
    "DATABASE": "yapi",
    "port": 27017,
    "user": "yapi",
    "pass": "密码",
    "authSource": ""
  },
  "mail": {
    "enable": true,
    "host": "smtp.163.com",
    "port": 465,
    "from": "***@163.com",
    "auth": {
      "user": "***@163.com",
      "pass": "*****"
    }
  }
}

特别注意：确保 db 部分与本地 MongoDB 的配置一致。

5. 初始化 YApi 数据库

YApi 提供了初始化脚本，用于创建所需集合并生成管理员账号。运行以下命令：

node install/install.js

按照提示完成管理员账号和密码的设置，初始化完成后 MongoDB 中将自动生成 yapi 数据库及相关集合。

6. 使用 PM2 管理 YApi 服务

利用 PM2 可以方便地管理 YApi 的启动、停止、重启及日志查看。

6.1 安装 PM2

全局安装 PM2：

npm install -g pm2

验证安装：

pm2 -v

6.2 使用 PM2 启动 YApi 服务

在 YApi 项目根目录下，假设入口文件为 vendors/server/app.js（部分版本可能略有不同），使用以下命令启动并指定进程名称为 yapi：

pm2 start ~/yapi/vendors/server/app.js --name yapi

如需传递环境变量或参数，可使用 -- 参数。例如：

pm2 start ~/yapi/vendors/server/app.js --name yapi -- --port=3000

6.3 查看 PM2 进程及日志

查看进程列表：

pm2 list

查看所有日志：

pm2 logs

查看指定进程（如 yapi）日志：

pm2 logs yapi

6.4 管理 PM2 进程

停止 YApi 服务：

pm2 stop yapi

重启 YApi 服务：

pm2 restart yapi

删除 YApi 服务（停止并从 PM2 管理中移除）：

pm2 delete yapi

6.5 配置 PM2 开机自启

确保服务器重启后 YApi 服务能自动启动，请按以下步骤配置 PM2 开机自启：

生成启动脚本：

pm2 startup

保存当前 PM2 进程列表：

pm2 save

以后重启系统后，PM2 会根据保存的进程列表自动恢复服务。

7. 访问 YApi

启动 YApi 后，在浏览器中访问：

http://localhost:3000

使用初始化时设置的管理员账号和密码登录后台管理系统，即可开始使用 YApi 进行接口管理与测试。