接口管理 | 除了swagger,还有Yapi这种接口管理的利器!

>>强大,10k+点赞的 SpringBoot 后台管理系统竟然出了详细教程!

安装MongoDB

我之前写过一篇文章:MongoDB从0开始到实践,整的很明白

这里面有详细的MongoDB的安装与使用,请阅。

安装Node.js

wget https://nodejs.org/dist/v12.18.2/node-v12.18.2-linux-x64.tar.xz

tar -xf node-v12.18.2-linux-x64.tar.xz -C /usr/local/

cd /usr/local

mv node-v12.18.2-linux-x64/ nodejs

配置环境变量

vim /etc/profile

export NODEJS_HOME=/usr/local/nodejs
export PATH=$PATH:$JAVA_HOME/bin:$MONGODB_HOME/bin:$NODEJS_HOME/bin

安装Yapi

两行命令

npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server 
接口管理 | 除了swagger,还有Yapi这种接口管理的利器!

在浏览器输入:http://192.168.242.110:9090/

接口管理 | 除了swagger,还有Yapi这种接口管理的利器!

部署之前记得要启动mongodb服务

mongod -f /usr/local/mongodb/conf/mongod.conf

注意,这里的数据库地址和数据库端口是指MongoDB的地址和端口,根据实际情况填写。

输入一些信息,开始部署

接口管理 | 除了swagger,还有Yapi这种接口管理的利器!

部署时间可能有点长,别着急,让子弹先飞一会儿...

接口管理 | 除了swagger,还有Yapi这种接口管理的利器!

在控制台也能看到信息:

接口管理 | 除了swagger,还有Yapi这种接口管理的利器!

按照它的指示操作:

cd /root/my-yapi
# 执行
node vendors/server/app.js
接口管理 | 除了swagger,还有Yapi这种接口管理的利器!

在浏览器输入:http://192.168.242.110:3000/接口管理 | 除了swagger,还有Yapi这种接口管理的利器!

OK,成功,输入账号admin@admin.com,密码ymfe.org即可登录。

但是我们不想让别人注册,只有我们自己人能用,这时需要禁用注册功能, 在 /root/my-yapi/config.json 添加 closeRegister:true 配置项,就可以禁止用户注册 yapi 平台,修改完成后,重启 yapi 服务器。

{
  "closeRegister":true
}

效果如图:

接口管理 | 除了swagger,还有Yapi这种接口管理的利器!

安装部署到这里就Ok了,还有一个小问题就是我们一直都是前台启动的,怎样优雅的后台启动yapi?

这里需要使用node的一个守护工具包pm2,其安装与使用方法:

# 安装pm2
npm install pm2 -g  
cd  {项目目录}
# pm2管理yapi服务
pm2 start "vendors/server/app.js" --name yapi 
pm2 info yapi
pm2 stop yapi
pm2 restart yapi
接口管理 | 除了swagger,还有Yapi这种接口管理的利器!

使用

使用相当简单,看图:

创建项目:

接口管理 | 除了swagger,还有Yapi这种接口管理的利器!
接口管理 | 除了swagger,还有Yapi这种接口管理的利器!

在项目下创建接口:

接口管理 | 除了swagger,还有Yapi这种接口管理的利器!

还有创建分组等其他使用的功能,自己把环境支棱起来,随便玩。


首发公众号 「行百里er」 ,欢迎老铁们关注阅读指正。代码仓库 「GitHub」 github.com/xblzer/JavaJourney


原文始发于微信公众号(行百里er):接口管理 | 除了swagger,还有Yapi这种接口管理的利器!