YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
github地址:https://github.com/YMFE/yapi
- 特性:
基于 Json5 和 Mockjs 定义接口返回数据的结构和文档,效率提升多倍
扁平化权限设计,即保证了大型企业级项目的管理,又保证了易用性
类似 postman 的接口调试
自动化测试, 支持对 Response 断言
MockServer 除支持普通的随机 mock 外,还增加了 Mock 期望功能,根据设置的请求过滤规则,返回期望数据
支持 postman、har、swagger 数据导入
免费开源,内网部署
- node安装:
mkdir /software && cd /software
vim node_install.sh
#!/bin/bash
#用于安装node
NODE_VER=v12.14.0
[ ! -d /software/ ] && mkdir /software
install_node() {
tar xf node-$NODE_VER-linux-x64.tar.xz
[ ! -d /usr/local/node ] && mv node-$NODE_VER-linux-x64 /usr/local/node
n=`grep 'NODE_HOME=/usr/local/node' /etc/profile |wc -l`
if [ $n -eq 0 ]
then
echo 'NODE_HOME=/usr/local/node' >> /etc/profile
echo 'PATH=$NODE_HOME/bin:$PATH' >> /etc/profile
echo 'NODE_PATH=$NODE_HOME/lib/node_modules:$PATH' >> /etc/profile
echo 'export NODE_HOME PATH NODE_PATH' >> /etc/profile
echo 'export NVM_NODEJS_ORG_MIRROR=http://npm.taobao.org/mirrors/node' >> /etc/profile
source /etc/profile
else
source /etc/profile
fi
}
start() {
cd /software
#安装node
if [ ! -f node-$NODE_VER-linux-x64.tar.xz ]
then
echo -e "\033[32m正在下载node到/software\033[0m"
wget https://npm.taobao.org/mirrors/node/$NODE_VER/node-$NODE_VER-linux-x64.tar.xz
install_node
else
install_node
fi
}
start
node -v
if [ $? -eq 0 ]
then
echo -e "\033[36mnode安装完成\033[0m"
else
echo -e "\033[31mnode安装失败\033[0m"
exit 1
fi
sh node_install.sh
source /etc/profile
node -v
yum install -y git
- mongodb安装:
cat > /etc/yum.repos.d/mongodb.repo <<EOF
[mongodb-org-4.4]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/\$releasever/mongodb-org/4.4/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-4.4.asc
EOF
yum clean all && yum makecache fast
yum install -y mongodb-org
mkdir -p /data/mongod
chown -R mongod:mongod /data/mongod
vim /etc/mongod.conf #修改数据存储目录
storage:
dbPath: /data/mongod
systemctl enable mongod && systemctl start mongod
- yapi安装:
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
打开ip:9090
,输入相应的配置和点击开始部署,完成整个网站的部署。
- 启动yapi:
cd /data/yapi
node vendors/server/app.js
打开ip:3000
,账号/密码:admin@admin.com
/ymfe.org
。
- 服务管理:
使用 pm2 方便服务管理维护。
npm install pm2 -g #安装pm2
cd /data/yapi
pm2 start "vendors/server/app.js" --name yapi #pm2启动yapi服务
pm2 info yapi #查看服务信息
pm2 stop yapi #停止服务
pm2 restart yapi #重启服务
- 版本升级:
升级项目版本是非常容易的,并且不会影响已有的项目数据,只会同步 vendors
目录下的源码文件。
cd /data/yapi
yapi ls #查看版本号列表
yapi update #更新到最新版本
yapi update -v <Version> #更新到指定版本
至此,yapi部署完成,整个过程比较简单。
详细用法参考:官方教程
版权声明:本文为miss1181248983原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。