Linux 部署 YAPI

Cover


安装

  • 搭建 YApi 前需安装 nodejs 建议安装版本 12.x,高版本搭建时会出现异常
  • 搭建前需安装 MongoDB,根据 linux 发行版自行安装
    • MongoDB 启动命令

      1
      mongod --logpath=/data/logs --fork

创建安装主目录,并进入该目录

1
2
mkdir yapi
cd yapi

克隆项目到目录 vendors

1
git clone [email protected]:shayne/yapi.git vendors

将项目下的配置文件实例,复制到 yapi 主目录下

1
cp vendors/config_example.json ./config.json

注意
请根据情况,修改 config.json 配置信息:
port 默认端口 3000
closeRegister 禁止用户通过系统自行注册
adminAccount 管理员账户,初始化使用
包括数据库连接信息,db.user、 db.pass、 db.authSource 为 “”(空字符)即可

修改安装源信息为淘宝源,并进行 yapi 安装

1
2
npm install --production --registry https://registry.npm.taobao.org
npm run install-server

注意
安装程序会初始化数据库索引和管理员账号,管理员账号名可在 config.json 配置
安装初始化完成后,控制台中会显示帐号信息,包括帐号及密码

启动 yapi

1
node server/app.js

常见问题

  • 原版本在关闭注册及为使用 LDAP 时无法创建新用户,以上安装版本已修改为可通过工具调用新增用户 API 版本:
    POST
    Headers : 传输 Cookie 参数
    BODY : JSON,

    1
    { "email":"[email protected]", "password":"pwd" }
  • 原版本中用户很多主要信息不能修改,包括邮箱,权限等,可通过后台连接 MongoDB 进行修改:
    连接 MongoDB

    1
    mongo

    进入 yapi 数据库

    1
    use yapi

    通过帐号或邮箱查询用户 id

    1
    2
    db.getCollection("user").find({"username":"acc"})
    db.getCollection("user").find({"email":"[email protected]"})

    根据返回的 id 对用户权限或其他信息进行修改

    1
    db.getCollection("user").update({"_id":2}, {$set: {"role":"admin"}})

    提示
    权限说明: admin 为管理员权限,member 为会员权限