Ubuntu下Yapi的安装与配置
YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。最近公司想用这款服务,安装的时候网上资料很少,于是自己在参考一些前辈的安装教程之后自己总结一下我的安装历程。
安装yapi之前必须要安装的辅助软件有node.js和MongoDB,安装过程如下:
安装nodejs和npm
- 获取安装node.js的资源
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash - 安装nodejs
sudo apt-get install -y nodejs - 查看nodejs的版本信息
nodejs -v
注:此处安装的node.js并不是常用的node,可以通过以下命令进行建立软连接,让安装的node与nodejs建立软连接,接着就可以使用 node命令,
sudo ln -s /usr/bin/nodejs /usr/bin/node
因为npm是一个包含在node.js里面的一个包管理工具,就如同linux中的yum仓库,rpm包管理;那么在安装完node.js后就已经将npm也安装上了。如果想单独更新npm,可以通过如下命令进行更新:
npm install npm@latest -g
npm install npm@next -g
这时node就已经安装好了
查看版本信息:
安装时的bug:在部署node.js 的过程中,当输入如下命令时,结尾总是报错有一部分文件无法下载,如下图所示:
再直接输入安装nodejs命令,就会报错,
这是因为前面下载过的nodejs,残余的部分文件导致
这时我们切换到/etc/apt/source.list.d目录下面
将第一个文件node_js,若没有该文件则将elastic.co文件删除再重新执行下载安装就不会报错:
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash
安装MongoDB
在开始之前,请确保系统上未安装 mongodb,
首先,我们必须导入公钥:
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 9DA31620334BD75D9DCB49F368818C72E52529D4
在源列表中添加一个新的仓库,以便可以安装 MongoDB 社区版并获得自动更新:
echo “deb [ arch=amd64 ] https://repo.mongodb.org/apt/ubuntu $(lsb_release -cs)/mongodb-org/4.0 multiverse” | sudo tee /etc/apt/sources.list.d/mongodb-org-4.0.list
更新本地库以便系统知道可用的新包,命令:
sudo apt install -y mongodb-org
现在你可以安装最新稳定版的 MongoDB:
sudo apt install -y mongodb-org
或者想要安装某个特定版本(在 = 后面修改版本号)
sudo apt install -y mongodb-org=4.0.6 mongodb-org-server=4.0.6 mongodb-org-shell=4.0.6 mongodb-org-mongos=4.0.6 mongodb-org-tools=4.0.6
为阻止MongoDB自动更新为最新版本,并冻结为已安装的版本,
依次输入如下命令
echo “mongodb-org hold” | sudo dpkg --set-selections
echo “mongodb-org-server hold” | sudo dpkg --set-selections
echo “mongodb-org-shell hold” | sudo dpkg --set-selections
echo “mongodb-org-mongos hold” | sudo dpkg --set-selections
echo “mongodb-org-tools hold” | sudo dpkg --set-selections
此时mongodb已经安装成功,需要修改配置信息,则输入如下命令:
vim /etc/mongod.conf
进行修改配置文件,网上有许多的修改MongoDB配置文件的教程,在此就不多说了。
在MongoDB安装成功之后,
启动MongoDB
sudo service mongod start
查看状态
sudo service mongod status
关闭
sudo service mongod stop
卸载 MongoDB
运行以下命令:
sudo service mongod stop
sudo apt purge mongodb-org*
要删除数据库和日志文件(确保备份你要保留的内容!):
sudo rm -r /var/log/mongodb
sudo rm -r /var/lib/mongodb
Mongodb的重启
/usr/bin/mongod -f /etc/mongod.conf &
安装部署Yapi
安装好nodejs npm mongodb 之后在根目录下输入命令:
1.) npm install -g yapi-cli --registry
2.) https://registry.npm.taobao.org
在根目录下 输入命令: yapi server
在安装包下载好之后,会自动运行项目,这时根据提示在浏览器输入9090端口的网址,进入如下页面:
在此界面进行对Yapi的配置,当信息输入完成之后,点击开始部署,当出现如下信息的时候,则Yapi部署成功。
在服务器终端输入命令: 切换到部署目录下
cd /root/my-yapi
启动服务器如图:
node vendors/server/app.js
在浏览器端输入访问的地址:服务器地址:3000
输入登录信息,进入主界面,登录用户信息,如上图提示信息
初始化管理员账号成功,账号名:“xxxx”,密码:“xxxx”
注:
- 部署成功,请切换到部署目录,输入: “node vendors/server/app.js” 指令启动服务器, 然后在浏览器打开 http://127.0.0.1:3000 访问
若地址无法访问,防火墙拦截
设置关闭防火墙Ubuntu下
sudo ufw disable
开发防火墙命令
sudo ufw enable
查看防火墙状态
sudo ufw status
active表示防火墙开启
inactive表示防火墙关闭
- 上述安装是在默认为情况下进行安装
后期可以修改配置文件信息,进入部署目录下
cd /root/my-yapi
vim config.json
如图端口,用户信息,邮箱都可以进行修改
- 使用命令下载好YApi之后
npm install -g yapi-cli --registry https://registry.npm.taobao.org
需要回到根目录下启动yapi.否则报yapi server 找不到对应的目录或文件夹如下图:
如在根目录下启动:
这只是我个人在部署这个软件的时候记录的一个过程和遇到常见的问题。如果跟某些大佬有相似的地方,嗯…如有雷同,纯属我借鉴大佬,侵删,感恩!