YAPI安装使用

原创已于 2024-11-18 16:07:35 修改 · 318 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#yapi

于 2024-11-18 16:00:16 首次发布

前置条件

数据库：mongoDB 已经安装完全。
（可以参考 https://blog.youkuaiyun.com/IT_ZRS/article/details/118642997/ 我按这个方式失败）

安装包准备

在服务器上
创建目录 my-yapi
将下载的文件夹 vendors 和配置文件config.json 放在该文件夹下面
在这里插入图片描述
其中配置文件 config.json

{
  "port": "3000",
  "adminAccount": "***@***",
  "timeout":120000,
   "db": {
      "servername": "***",
      "DATABASE": "***",
      "port": "***"
   },
   "mail": {
      "enable": false,
      "host": "***.***.***",
      "port": ***,
      "from": "***@163.com",
      "auth": {
         "user": "***@163.com",
         "pass": "*****"
      }
  }
}

文件夹vendors
在这里插入图片描述

开始安装

npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
node server/app.js //启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候

使用进程管理工具（如 PM2）
PM2 是一个流行的 Node.js 进程管理工具，可以方便地管理和监控 Node.js 应用。

安装 PM2：
npm install -g pm2
使用 PM2 启动应用：
pm2 start server/app.js
查看应用状态：
pm2 status

如果部分门没有满足需要根据下面命令选择对应的命令执行

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

同时也可以采用自动化部署方式部署，但容易报错，我就是按这个方式安装报错，后选择上面方法。