实战必备开发工具解析眼前一亮,接口文档yapi工具安装

Posted 小黄鸡1992

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了实战必备开发工具解析眼前一亮,接口文档yapi工具安装相关的知识,希望对你有一定的参考价值。

一.安装git

yum -y install git

git --version

二.安装mongodb

三.安装node.js

可以参考      但是注意版本过高也会出现警告

四.安装yapi

这里楼主使用的是下载后 执行安装(原因是可视化部署时报错较多)

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

config.json

{
  "port": "3000", #运行端口号
  "adminAccount": "demo@demo.com", #账号名称
  "timeout":120000,
  #mongodb权限一定要配置正确 否则会报权限错误 
  "db": {
    "servername": "127.0.0.1",
    "DATABASE": "admin",
    "port": 27017,
    "user": "root",
    "pass": "123456",
    "authSource": ""
  },
  "mail": {
    "enable": true,
    "host": "smtp.163.com",
    "port": 465,
    "from": "***@163.com",
    "auth": {
      "user": "***@163.com",
      "pass": "*****"
    }
  }
}

安装成功后访问ip:3000(上文配置文件的端口 请注意开启端口号)

出现页面则代表安装成功

五.安装pm2

以上安装完成后 yapi不能后台启动 所以需要安装pm2

npm install pm2 -g

出现以下提示则表示安装成功

然后执行以下操作  /usr/local/node/node-v13.13.0-linux-x64/lib/node_modules/pm2/bin/pm2为红框位置 请根据自己的配置修改

ln -s /usr/local/node/node-v13.13.0-linux-x64/lib/node_modules/pm2/bin/pm2 /usr/local/bin/

执行命令 app.js路径为安装位置的路径 请根据配置修改

pm2 start "/usr/local/yapi/vendors/server/app.js" --name yapi

出现以下则代表成功

错误一 以下问题 则是用户权限有问题 需要在mongodb下执行以下命令

db.updateUser(
 "root",
        {
            roles : 
            [
                  {"role" : "userAdminAnyDatabase","db" : "admin"},
                  {"role" : "dbOwner","db" : "admin"},
                  {"role" : "clusterAdmin", "db": "admin"}
             ]
        }
)      

错误二 文件夹权限不够

执行

chmod 777 /usr/local/yapi/vendors/node_modules

 

以上是关于实战必备开发工具解析眼前一亮,接口文档yapi工具安装的主要内容,如果未能解决你的问题,请参考以下文章

实战必备开发工具解析眼前一亮,接口文档yapi工具使用

实战必备开发工具解析眼前一亮,接口文档yapi工具使用

使用yapi工具编辑接口文档

一站式接口文档及测试工具yapi介绍

让面试官眼前一亮的项目,JAVA面试必备

使用yapi工具编辑接口文档