目录
一、介绍
Apifox 是接口管理、开发、测试全流程集成工具,定位 Postman + Swagger + Mock + JMeter
。只要定义好接口文档,接口调试、数据 Mock、接口测试就可以直接使用,无需再次定义。
1、开发测试过程中的现状
yapi -- 管理接口文档
rap -- 前端开发mock数据
postman -- 开发调试接口、测试调用接口
jmeter -- 基本的压力测试
2、存在的问题和痛点
-
接口文档和实际开发的接口数据类型可能存在不一致,导致前后端未达成统一,测试时遇到问题,耗费时间;
-
一个接口,至少被定义四次:服务端开发调试时、前端开发mock时、接口测试时、jmeter压测时,在需求量大,开发、测试时间紧迫时,重复定义接口,显得有些浪费资源;
-
测试中有时需要通过更改数据库数据,再调用接口,来进行测试,频繁操作时,比较麻烦;
3、用apifox可以解决的问题
-
提高开发接口数据类型的规范型,前后端双方都完全遵守接口定义的规范,使得联调更加顺利;
-
提高服务端冒烟通过率,开发定义好接口并调通后,可以立即保存为一个测试用例,测试可以在提测前根据这个模板提前编写接口测试用例给开发自测;
-
数据共享,只需开发定义一次接口,即可实现多种操作,减少他人因为配置错误等问题导致的接口调试失败几率,从而节省一定的时间;
-
连接数据库,快速准备需要的测试数据;
二、安装
下载安装包后,一键安装即可。下载链接:Apifox - API 文档、调试、Mock、测试一体化协作平台 - 接口文档工具,接口自动化测试工具,接口Mock工具,API文档工具,API Mock工具,API自动化测试工具
三、使用
1、使用场景
后端开发
-
接口文档管理
-
后端代码自动生成
-
接口调试
-
接口自测
前端开发
-
接口文档管理
-
接口数据 Mock
-
接口调试
-
前端代码自动生成
测试人员
-
接口调试
-
接口测试
-
性能测试
2、基本功能
1)团队协作
接口数据云端同步,实时更新;支持团队/项目管理员、普通成员、只读成员等权限管理
-
安装后,登录自己的账号,由团队成员邀请加入,通过后,即可共享团队所有项目的接口数据
2)导入导出
导入接口文档
以YApi举例
-
从yapi平台,选择服务-数据管理,导出json格式的文件
-
apifox - 接口管理 - 导入,选择数据格式为YApi,导入json文件
-
导入成功后,点击接口管理,即可看到导入的接口数据
导入抓包数据
3)接口&用例
定义接口的请求信息、基础状态信息、response示例信息
通过前置、后置操作,对数据进行处理和断言;
自动校验接口中定义的response数据结构,也可自定义response校验点
测试用例集
测试用例主要用来做接口集合测试,每个用例包含多个测试步骤,每个步骤都是一个接口请求
查看测试报告
可以查看历史的执行记录,目前测试报告数据仅存放在本地电脑
基本的性能测试
执行用例时,可设置循环次数、线程数,可导入批量的测试数据
4)快速mock
根据接口定义的数据结构自动生成测试数据,无需配置mock规则,方便前端调试
5)变量的管理及使用
公共数据可配置远程值:“远程值”会同步保存到服务器,仅用于成员之间相互同步,实际运行时都是读写“本地值”
自己的测试数据可配置本地值:“本地值”仅保存在本地,不会同步到服务器,团队成员之间也不会相互同步
外部使用变量:{ {变量名}
脚本中获取/设置变量:通过get/set
6)数据库连接
项目设置 - 数据库连接,可管理连接的数据库
数据库连接信息仅存储在本地,不会同步到云端,所以使用时,需自己手动设置
7)自定义脚本
apifox支持多种语言脚本:java、python、PHP、js等
举个栗子
自定义python脚本,获取外部的传参
在指定目录下,放入自己的脚本
apifox调用脚本、传参