一、基础环境
1、github
2、特性
基于 Json5 和 Mockjs 定义接口返回数据的结构和文档,效率提升多倍
扁平化权限设计,即保证了大型企业级项目的管理,又保证了易用性
类似 postman 的接口调试
自动化测试, 支持对 Response 断言
MockServer 除支持普通的随机 mock 外,还增加了 Mock 期望功能,根据设置的请求过滤规则,返回期望数据
支持 postman, har, swagger 数据导入
免费开源,内网部署,信息再也不怕泄露了
3、版本更新
https://github.com/YMFE/yapi/blob/master/CHANGELOG.md
二、安装步骤
( 本地部署YApi需要先安装nodejs和MongoDB,参考其他教程。本文使用docker安装,请先准备docker环境。)
1、拉取镜像
docker pull yapi名称
2、创建本地文件夹,用于mongodb存储数据,与docker容器映射
mkdir -p /Users/yapi/mongodata
3、启动mongodb
docker run --restart always -v /Users/yapi/mongodata:/data/db -d --name yapimongo mongo名称
4、配置YApi
docker run -it --rm --link yapimongo:mongo --entrypoint npm --workdir /api/vendors yapi名字:版本号 run install-server
执行完后,会初始化管理员账号、密码
> yapi-vendor@1.8.5 install-server /api/vendors
> node server/install.js
log: mongodb load success...
初始化管理员账号成功,账号名:"admin@admin.com",密码:"ymfe.org"
5、启动YApi
docker run -d --restart=always --name yapi --link yapimongo:mongo --workdir /api/vendors -p 3000:3000 yapi名字:版本号 server/app.js
输入: http:\ip:3000 进入可视化页面(前面的3000代表访问端口)
登录账号:admin@admin.com,密码:ymfe.org
三、升级YApi
#1、停止并删除旧版容器
docker rm -f yapi名称/imagesID
#2、获取最新镜像
docker pull yapi名称
#3、启动新容器
docker run -d --name yapi --link yapimongo:mongo --workdir /api/vendors -p 3000:3000 yapi名称:版本号 server/app.js