接口管理平台YApi安装配置

环境要求

nodejs（7.6+)
mongodb（2.6+）

#安装Node

cd /usr/local/src #https://nodejs.org/dist/v8.17.0/node-v8.17.0-linux-x64.tar.gz

wget https: / /nodejs.org/dist/v8.17.0/node -v8. 17.0 -linux-x64.tar.gz

tar zxvf node-v8. 17.0 -linux-x64.tar.gz

cp node-v8. 17.0 -linux-x64/bin/node /usr/local/bin/

cp -R node-v8. 17.0 -linux-x64/ lib / node_modules / usr / local / lib /

ln -s /usr/local/ lib / node_modules / npm / bin / npm - cli . js / usr / local / bin / npm

npm install -g pm2@latest --registry= http: / /registry.npm.taobao.org #安装pm2模块

npm install -g npm@latest --registry=http://registry.npm.taobao.org #安装npm模块

# Linux Binaries下载地址： https: / /nodejs.org/dist

#配置MongoDB源

cat /etc/yum.repos.d/mongodb-org.repo

[mongodb-org]

name=MongoDB Repository

baseurl=https://mirrors.aliyun.com/mongodb/yum/redhat/$releasever/mongodb-org/3.6/x86_64/

gpgcheck=0

enabled=1

gpgkey= https://www.mongodb.org/static/pgp/server-3.6.asc

#安装MongoDB

yum install mongodb-org -y

#相关目录信息

/var/lib/mongo #数据目录

/var/log/mongodb #日志目录

/var/run/mongodb #PID文件目录

配置远程访问

修改mongod.conf 文件

bindIP: 127.0.0.1

修改为

bindIP: 0.0.0.0

关闭防火墙或把Mongodb的端口号27017加入到安全组

CentOS7关闭防火墙命令如下：

#停止firewall

systemctl stop firewalld.service

#禁止firewall开机启动

systemctl disable firewalld.service

添加连接认证

use admin db.createUser( { user: "myUserAdmin", pwd: "abc123", roles: [ { role: "userAdminAnyDatabase", db: "admin" }, "readWriteAnyDatabase" ] } )

修改mongod.conf 文件

security：

authorization: enabled

1.以用户管理员身份进行连接和身份验证

验证方式：

通过传入用户凭据来连接身份验证

mongo命令使用：-u <username> -p <password> --authenticationDatabase <database>

切换到身份验证数据库（在本例中为admin），并使用方法进行身份验证：

db.auth(<username>,<pwd>)

use admin

db.auth("myUserAdmin", "abc123" )

# https://docs.mongodb.com/manual/tutorial/install-mongodb-on-red-hat/

# https://docs.mongodb.com/manual/tutorial/enable-authentication/

# https://blog.csdn.net/weixin_33981932/article/details/94334371

# https://yangxx.net/?p=2488

内网部署

使用我们提供的 yapi-cli 工具，部署 YApi 平台是非常容易的。建议部署成 http 站点，因 chrome 浏览器安全限制，部署成 https 会导致测试功能在请求 http 站点时文件上传功能异常。

如果您是将服务器代理到 nginx 服务器，请配置 nginx 支持 websocket。

在location /添加

proxy_http_version 1.1;

proxy_set_header Upgrade $http_upgrade;

proxy_set_header Connection "upgrade";

安装

方式一. 可视化部署[推荐]

执行 yapi server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码(ymfe.org) 登录系统（默认密码可在个人中心修改）。

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

...

初始化管理员账号成功,账号名："yapi@yapi.cn"，密码："ymfe.org"

部署成功，请切换到部署目录，输入： "node vendors/server/app.js" 指令启动服务器, 然后在浏览器打开 http://127.0.0.1:8090 访问

停掉yapi server，按照如上方式启动服务，或者通过pm2进行服务管理

方式二. 命令行部署

如果 github 压缩文件无法下载，或需要部署到一些特殊的服务器，可尝试此方法

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

|-- init.lock

|-- log

`-- vendors

|-- CHANGELOG.md

|-- LICENSE

|-- README.md

|-- client

|-- common

|-- config_example.json

|-- doc |-- exts

|-- nodemon.json

|-- npm-debug.log

|-- package.json

|-- plugin.json

|-- server

|-- static

|-- test

|-- webpack.alias.js

|-- yapi-base-flow.jpg

|-- ydocfile.js

`-- ykit.config.js

服务器管理

推荐使用 pm2 管理 node 服务器启动，停止，具体使用方法可参考下面的教程：

cat yapi-server.json

{

"apps":

{

"name": "yapi server",

"cwd": "/usr/local/my-yapi",

"script": "node",

"args": "vendors/server/app.js",

"min_uptime": "60s",

"max_restarts": 30,

"max_memory_restart": "128M",

"watch": true

}

pm2 start yapi-server.json

pm2 save

pm2 startup

Nginx配置

cat yapi.conf

upstream yapi {

server 127.0.0.1:8090;

}

server {

listen 80;

server_name 192.168.1.48;

if ($http_user_agent ~* "qihoobot|Baiduspider|Googlebot|Googlebot-Mobile|Googlebot-Image|Mediapartners-Google|Adsbot-Google|Feedfetcher-Google|Yahoo! Slurp|Yahoo! Slurp China|YoudaoBot|Sosospider|Sogou spider|Sogou web spider|MSNBot|ia_archiver|Tomato Bot") {

return 403;

}

location / {

proxy_pass http://yapi;

proxy_redirect default;

proxy_http_version 1.1;

proxy_set_header Upgrade $http_upgrade;

proxy_set_header Connection "upgrade";

proxy_set_header Host $host:$server_port;

proxy_set_header X-Real-IP $remote_addr;

proxy_set_header X-Forwarded-Host $host:$server_port;

proxy_set_header X-Forwarded-Server $host;

proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

proxy_set_header X-Forwarded-Proto $scheme;

proxy_next_upstream error timeout invalid_header http_502 http_503 http_504;

proxy_ignore_client_abort on;

proxy_read_timeout 180;

proxy_buffering on;

proxy_buffer_size 8k;

proxy_buffers 8 8M;

charset utf-8;

client_body_buffer_size 10M;

gzip on;

gzip_min_length 1000;

gzip_types text/plain text/css application/json text/xml application/xml application/xml+rss text/javascript;

}

access_log /home/wwwlogs/yapi.access.log;

error_log /home/wwwlogs/yapi.error.log;

}

升级

升级项目版本是非常容易的，并且不会影响已有的项目数据，只会同步 vendors 目录下的源码文件。

cd {项目目录} yapi ls #查看版本号列表 yapi update #升级到最新版本 yapi update -v v1.1.0 #升级到指定版本

配置邮箱

打开项目目录 config.json 文件，新增 mail 配置，替换默认的邮箱配置

{
  "port": "*****",
  "adminAccount": "********",
  "db": {...},
  "mail": {
    "enable": true,
    "host": "smtp.163.com",    //邮箱服务器
    "port": 465,               //端口
    "from": "***@163.com",     //发送人邮箱
    "auth": {
        "user": "***@163.com", //邮箱服务器账号
        "pass": "*****"        //邮箱服务器密码
    }
  }
}

如何申请STMP服务器账号和密码可以参考下面的教程：如何开通电子邮箱的SMTP功能

配置LDAP登录

打开项目目录 config.json 文件，添加如下字段：

{
  "port": "*****",
  "adminAccount": "********",
  "db": {...},
  "mail": {...},
  "ldapLogin": {
      "enable": true,
      "server": "ldap://l-ldapt1.com",
      "baseDn": "CN=Admin,CN=Users,DC=test,DC=com",
      "bindPassword": "password123",
      "searchDn": "OU=UserContainer,DC=test,DC=com",
      "searchStandard": "mail",    // 自定义格式： "searchStandard": "&(objectClass=user)(cn=%s)"
      "emailPostfix": "@163.com",
      "emailKey": "mail",
      "usernameKey": "name"
   }
}

这里面的配置项含义如下：

enable 表示是否配置 LDAP 登录，true(支持 LDAP登录 )/false(不支持LDAP登录);
server LDAP 服务器地址，前面需要加上 ldap:// 前缀，也可以是 ldaps:// 表示是通过 SSL 连接;
baseDn LDAP 服务器的登录用户名，必须是从根结点到用户节点的全路径(非必须);
bindPassword 登录该 LDAP 服务器的密码(非必须);
searchDn 查询用户数据的路径，类似数据库中的一张表的地址，注意这里也必须是全路径;
searchStandard 查询条件，这里是 mail 表示查询用户信息是通过邮箱信息来查询的。注意，该字段信息与LDAP数据库存储数据的字段相对应，如果如果存储用户邮箱信息的字段是 email, 这里就需要修改成 email.（1.3.18+支持）自定义filter表达式，基本形式为：&(objectClass=user)(cn=%s), 其中%s会被username替换
emailPostfix 登陆邮箱后缀（非必须）
emailKey: ldap数据库存放邮箱信息的字段（v1.3.21 新增非必须）
usernameKey: ldap数据库存放用户名信息的字段（v1.3.21 新增非必须）

重启服务器后，可以在登录页看到如下画面，说明 ladp 配置成功

禁止注册

在 config.json 添加 closeRegister:true 配置项,就可以禁止用户注册 yapi 平台，修改完成后，请重启 yapi 服务器。

{
  "port": "*****",
  "closeRegister":true
}

版本通知

（v1.3.19+ 增加）在 config.json 添加 "versionNotify": true 配置项，就可以开启版本通知功能，默认为 false，修改完成后，请重启 yapi 服务器。

{
  "port": "******",
  "adminAccount": "*****",
  "versionNotify": true
}

如何配置mongodb集群

请升级到 yapi >= 1.4.0以上版本，然后在 config.json db项，配置 connectString:

{
  "port": "***",
  "db": {
    "connectString": "mongodb://127.0.0.100:8418,127.0.0.101:8418,127.0.0.102:8418/yapidb?slaveOk=true",
    "user": "******",
    "pass": "******"
  },
}

来源：oschina

链接：https://my.oschina.net/HeAlvin/blog/4885783

标签

mongodb

npm

Linux

javascript

node.js