前言
YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
一、部署nodejs
获取资源
curl -sL https://rpm.nodesource.com/setup_8.x | bash -
安装
yum install -y nodejs
查看node版本
node -v
查看npm版本
npm -v
二、部署mongodb
mongodb奇数版(如3.5)是开发版本,故选择安装v3.4。
2.1 添加yum源
修改文件mongodb-3.4.repo
vim /etc/yum.repos.d/mongodb-3.4.repo
添加下面的内容,wq保存。
[mongodb-org-3.4]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/3.4/x86_64/
gpgcheck= 0
enabled=1
2.2 安装
yum install -y mongodb-org
2.3 禁用selinux
官方教程有提到selinux对mongodb会产生负面影响,故选择禁用。
修改config文件
vim /etc/selinux/config
将SELINUX=enforcing改为SELINUX=disabled
,wq保存。
重启OS
reboot
三、部署YApi
3.1 安装
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
根据提示,浏览器访问 http://部署YApi服务器的IP:9090。
填写完信息后,点击“开始部署”。(大概等待1分钟)
3.2 修改配置
这里我们不急着根据提示进行启动,有些参数我们可以通过修改配置达到。
修改config.json
vim /root/my-yapi/config.json
修改下面的内容(邮箱可以不用163的),wq保存。
复制代码
{
"port": "80",
"adminAccount": "yizitadmin@yizit.cn",
"db": {
"servername": "127.0.0.1",
"DATABASE": "yapi",
"port": "27017"
},
"mail": {
"enable": true,
"host": "smtp.163.com",
"port": 465,
"from": "可用于发送邮件的163邮箱",
"auth": {
"user": "163邮箱",
"pass": "163邮箱对应的密码或授权码"
}
},
"ldapLogin": {
"enable": true,
"server": "ldap://你的LDAP服务器IP:389",
"baseDn": "CN=Admin,CN=Users,DC=test,DC=com",
"bindPassword": "123456",
"searchDn": "OU=UserContainer,DC=test,DC=com",
"searchStandard": "mail"
},
"closeRegister":true
}
-
- LDAP配置项(ldapLogin)
enable 表示是否配置 LDAP 登录,true(支持 LDAP登录 )/false(不支持LDAP登录);
server LDAP 服务器地址,前面需要加上 ldap:// 前缀,也可以是 ldaps:// 表示是通过 SSL 连接;
baseDn LDAP 服务器的登录用户名,必须是从根结点到用户节点的全路径;
bindPassword 登录该 LDAP 服务器的密码;
searchDn 查询用户数据的路径,类似数据库中的一张表的地址,注意这里也必须是全路径;
searchStandard 查询条件,这里是 mail 表示查询用户信息是通过邮箱信息来查询的。注意,该字段信息与LDAP数据库存储数据的字段相对应,如果如果存储用户邮箱信息的字段是 email, 这里就需要修改成 email.
- LDAP配置项(ldapLogin)
-
- 注册配置项(closeRegister)
值为true,表示禁止用户注册
值为false(缺损),表示允许注册
3.3 启动
切换到部署目录下
cd /root/my-yapi
启动服务
node vendors/server/app.js
由于修改了配置,所以直接访问 http://部署YApi服务器的IP/login。
(ps:没有进行4.2修改配置的话是访问http://部署YApi服务器的IP:3000/login)
配置了LDAP服务的登录页面
没有配 LDAP服务的登录页面
由于配置了禁止注册,故tab页有也不能注册
四、使用pm2进行服务管理
如果使用node vendors/server/app.js启动Yapi服务的话,如果我们把cmd窗口关闭了,这时候我们就无法访问Yapi了,这时候我们就可以使用 pm2 管理 node 服务器启动,停止
4.1:安装pm2
npm i -g pm2
4.2:pm2管理yapi服务
进入Yapi的部署目录执行
pm2 start "vendors/server/app.js" --name yapi
pm2操作Yapi基本命令:
pm2 info yapi //查看服务信息
pm2 start yapi //停止服务
pm2 stop yapi //停止服务
pm2 restart yapi //重启服务
评论区