前言
Yapi是去哪儿网开源的一款接口管理工具。接口的文档的管理是一件比较痛苦的事情,后端开发不得不使用很长的时间去维护繁杂冗余的文档,而前端开发也因为文档的不精确也浪费开发时间。
工作中接口返回的参数值包含很多的异常场景,前端不得不写一大串的判断逻辑。配合前段调试需要模拟很多场景,比较费时费力,而且很多场景到了项目后期才能调试,在提交测试时时间就会显得很紧张。
总结起来文档式的接口管理方式浪费心里和时间,Aapi这款工具的旨意将接口作为一个公共的可视化的方式打通前段、后台、测试环节,整合在一块,共同使用维护,提高接口的维护成本。
这款工具免费开源,部署简单,还具有官方文档。
环境准备
- 操作系统:centos 7 环境要求:(若已有一下环境则可跳过)
- nodejs>7.6
- mongodb>2.6
- git
安装nodejs
- 获取资源(部署nodejs尽可能选择偶数版本,因为偶数版本官方有较长的维护时间,故这次选择8.x。)
curl -sL https://rpm.nodesource.com/setup_8.x | bash -
- 安装
yum install -y nodejs
- 查看版本
node -v
- 查看npm版本
npm -v
安装mongodb
- 更新yum源,非必须但是更新一下无害
yum -y update
- 添加mongodb源文件,在/etc/yum.repos.d 创建一个 mongodb-org.repo 文件
touch /etc/yum.repos.d/mongodb-org.repo
- 编辑mongodb-org.repo文件
vim /etc/yum.repos.d/mongodb-org.repo
- 添加文件内容
[mongodb-org] name=MongoDB Repository baseurl=http://mirrors.aliyun.com/mongodb/yum/redhat/7Server/mongodb-org/3.2/x86_64/ gpgcheck=0 enabled=1
- 安装mongodb
yum install -y mongodb-org
- 启动mongodb
service mongod start
- 设置开机启动
chkconfig mongod on
- 打开moMongoDB(可忽略)
/bin/mongo
- 配置远程访问
- 修改mongod.conf配置文件
vim/etc/mongod.conf
- 注释 bindIp: 127.0.0.1
#bindIp: 127.0.0.1
- 重启mongod
service mongod restart
安装git
- 官方推荐,在内网部署的时候安装git,可以根据自己所需安装
yum -y install git
搭建YApi环境
搭建YApi
- 准备环境搭建完成后,开始搭建YApi,安装命令
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server(启动后可访问127.0.0.1:9090进行安装)
-
实例截图:
- 执行 yapi server 启动可视化部署程序,浏览器打开提示窗口上的地址,非本地服务器,将0.0.0.0替换指定的域名或IP,进入部署页面。
-
实例截图
- 根据项目实际需要可以修改部署信息,点击【开始部署】,完成部署任务
-
部署成功截图
4.根据部署日志截图上的提示信息,启动服务
启动服务:node vendors/server/app.js
启动服务(以守护进程启动):node vendors/server/app.js &
浏览器打开部署日志上的访问地址http://127.0.0.1:3000就可以访问搭建的YApi工具了(非本地服务器,将127.0.0.1替换指定的域名或IP),此时YApi环境搭建完成
################################通过docker方式快速搭建Ypai接口平台#############################################################################
1、启动 MongoDB
docker run -d --name mongo-yapi mongo
2、获取 Yapi 镜像,版本信息可在 阿里云镜像仓库 查看
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
3、初始化 Yapi 数据库索引及管理员账号
docker run -it --rm
--link mongo-yapi:mongo
--entrypoint npm
--workdir /api/vendors
registry.cn-hangzhou.aliyuncs.com/anoy/yapi
run install-server
4.启动 Yapi 服务
docker run -d
--name yapi
--link mongo-yapi:mongo
--workdir /api/vendors
-p 3000:3000
registry.cn-hangzhou.aliyuncs.com/anoy/yapi
server/app.js
5.使用Ypai
访问 http://localhost:3000 登录账号 admin@admin.com,密码 ymfe.org
########Yapi常用简单断言############################
assert.equal(status, 200) //判断httpCode是否为200
assert.equal(body.errmsg, "操作成功") //判断errmsg是否等于'操作成功’
assert.equal(body.rows[0].mdq_businesscirclename, '广州国际采购中心') //判断json中rows[0]的mdq_businesscirclename中是否等于'广州国际采购中心'
assert.equal(body.success, true) //判断success为true通过,否则失败
log(body.content.login) //记录日志
assert.equal(body.msg,undefined) //undefined表示不能为空
https://blog.csdn.net/oZhengTuoJiaSuo/article/details/105197359? .........环境搭建
https://hellosean1025.github.io/yapi/documents/index.html .....................使用教程
https://www.cnblogs.com/yinjia/p/10415920.html .....................HttpRunner接口测试框架
https://www.cnblogs.com/botoo/p/8513403.html.................HttpRunner接口测试框架 2
https://www.cnblogs.com/wangyuyang1016/p/10988841.html .....................接口漏洞介绍