Apifox是API文档、API调试、API Mock、API自动测试一体化协作平台,定位Swagger+Postman+Mock+JMeter。
只需要定义好API文档,API调试、API数据Mock、API自动化测试就可以直接使用。
API文档和API开发测试使用同一个工具,API调试完成后即可保证和API文档定义的一致性。
Apifox 是区分
接口设计
和接口运行
两个概念的。
- 接口设计:即 新建接口 界面或接口详情里的 编辑 界面,用途是 定义接口文档规范,而不是 运行 接口,所以该界面是只能定义接口基本信息、
参数名
及参数说明等,而不能设置参数值
。参数值、前置脚本/后置脚本 等信息请在接口运行
界面或接口用例
界面填写。- 接口运行:即接口详情里的 运行 界面,用途是 临时调试接口,运行 完后,需要点击
保存为用例
,才能将填写的 参数值、前置脚本/后置脚本 等信息保存下来;否则关闭 tab 后,这些信息将会丢失。
一、下载
官网:Apifox - API 文档、调试、Mock、测试一体化协作平台。拥有接口文档管理、接口调试、Mock、自动化测试等功能,接口开发、测试、联调效率,提升 10 倍。最好用的接口文档管理工具,接口自动化测试工具。Apifox = Postman + Swagger + Mock + JMeter。集接口文档工具、接口Mock工具、接口自动化测试工具、接口调试工具于一体,提升 10 倍研发效率。是最好用的API文档工具,API自动化测试工具,API Mock工具,接口文档管理工具,接口文档生成工具。https://apifox.com/
二、接口文档设计
新建接口:
定义接口文档规范:
定义接口路径、基本信息、参数名及参数说明,不能设置参数值。
接口路径:
不要包含http协议及域名,这部分在“环境管理”-“前置URL”中设置
Path参数以大括号{}包裹起来;如获取用户信息/future/member/{menber_id}/info
不可包含Query参数(即url?后的参数),在下方“请求参数”填写
请求参数:
Params参数:包含Query参数和Path参数两部分
Body参数:none、form-data、x-www-form-urlencoded、json、xml、binary、raw
类型为json或xml,需设置数据结构,数据结构可以引用数据模型。
接口发送请求时,会根据该设置自动在header加上对应Content-Type,无需手动
设置
Header、Cookie、Auth等
示例值
返回响应:
接口返回的HTTP状态码
返回内容的数据格式:JSON、XML、HTML、Raw、Binary
数据结构:仅JSON、XML可配置数据结构
当一个接口不同不同情况返回不同数据结构时,可设置多个返回响应
公共响应:
主要用于实现返回响应的复用,通常不同接口在某些情况下会返回相同的数据结构,如资源不存在(404)、服务器错误(500)等,可设置公共响应,避免重复编写,方便统一管理。
响应示例:
方便查阅接口文档的人快速了解数据结构。示例数据可设置多个:成功案例、
失败案例。
环境管理:
前置URL:接口运行时自动添加到接口路径前组成接口实际请求URL。
尾部不要加上反斜杠/
服务:当且仅当同一”环境“下,多个接口使用不同的”前置URL“时,才需要添加多个服务
环境变量:跟随环境切换而发生改变的变量
数据结构/数据模型:
数据结构:
主要使用在【接口设计】的返回响应和json/xml类型的Body参数。支持增删改、拖拽。
json/xml智能识别/快捷导入:已有JSON数据,导入后自动识别快捷生成。
预览:根据设计的数据结构,mock出假数据,方便查看数据结构的实际效果
生成代码:根据数据结构生成各种语言的代码
数据模型:
可复用的数据结构,根据项目需求,需新建,再引用。
在线分享:
定义好的API文档,可通过在线文档分享。在线文档支持与运行调试、修改环境变量。
导入:
支持多种数据格式的导入,方便项目迁移。导入可选的内容包括:接口
数据抓包:
在网页点击【F12】-【网络】