Yapi部署教程 基本介绍: Swagger经常被人吐槽界面不够好看、功能不够强大,其实有很多工具可以和Swagger结合使用,结合之后就会变得非常好用。Yapi就是这样一个非常好用的工具。 教程目的: 从零开始,在windows系统上部署一个Yapi接口管理平台,用于前后端接口测试,联调等。 流程介绍: 1.安装Node.js。Yapi是一个node应用,可以通过npm进行安装,管理的。 2.安装mongoDB。这是一个数据库管理软件,初始化就有一个专门为Yapi使用构建的数据库(yapi),为配置Yapi,权限管理等操作提供数据支持。 3.安装Yapi,并且使用可视化界面来部署Yapi平台 4.安装pm2。这是一个node应用进程管理器,以防我们误操作关闭终端导致Yapi平台被关闭。 开始教程: 安装Node (1)打开链接nodejs.org/en/download…
(2)下载好之后,打开该文件,点击next,进入以下页面,勾选协议,继续next
(3)选择自己要安装地址,点击next
(4)后面一路next然后install即可
(5)安装完成后打开终端(win+r,输入cmd后点击回车),输入命令node -v查看Node版本,输入npm -v 查看npm版本信息。出现相应版本号即说明安装成功!
安装mongoDB (1)点击链接www.mongodb.com/try/downloa…
(2)下载后打开安装包,出现一下界面,点击next
(3)勾选协议,点击next
(4)选择custom进行自定义安装
(5)选择安装的地址,点击next
(6)选择日志配置和数据存储地址,点击next
(7)这里是MongoDB的可视化插件,建议取消勾选,一是因为下载网速较慢,取消能加快安装速度;再者我们配置Yapi其实不需要数据库的可视化界面。
(8)点击install开始安装
(9)安装完成后,进入我们刚刚的安装地址,进入bin目录,双击mango.exe文件,启动数据库客户端,弹出黑色对话框,并显示一个地址一般是127.0.0.1:27017
(10)打开浏览器,输入地址127.0.0.1:27017,显示以下信息,表示数据库启动成功!
配置Yapi (1)打开终端,输入npm安装指令:npm install -g yapi-cli --registry registry.npm.taobao.org,安装yapi-cli。显示以下信息则表示安装成功
(2)输入ypai server ,启动可视化部署页面
(3)打开浏览器,输入0.0.0.0:9090,出现以下页面则说明启动成功。根据自身情况,配置相关信息,数据库地址,端口号,数据库名称一般选择默认就可以。配置完成,点击开始部署。
(4)点击开始部署后,会出现一下页面,等待部署
部署完成后可以在最下方看到信息,提示你管理员账号和密码,以及启动方式
(5)除上诉提示的方式外,此外还可以通过另外一种方式启动,找到我们刚刚部署的地址,依次次点击vendors、server可以看到一下目录,注意有个app.js文件
而后按住shift同时在空白处点击右键,选择在此处打开powershell,在弹出的对话框中输入指令node app.js,出现一下信息,显示我们的yapi已经启动成功
(6)打开浏览器,输入网址127.0.0.1:3000,即可查看到相应的管理页面,点击登录/注册, 进入管理页面
输入之前提示的账号密码进行登录,即可进入操作页面
配置pm2进行启动/关闭 打开终端输入npm install -g pm2,进行安装 输入pm2 start ‘app.js文件地址’启动 例如我的yapi是安装在/usr/local/my-yapi 启动执行: pm2 start /usr/local/my-yapi/vendors/server/app.js 关闭执行: pm2 stop /usr/local/my-yapi/vendors/server/app.js 后续: 关于yapi的具体使用可以到hellosean1025.github.io/yapi/相关文档