1. 环境管理
一个项目在不同的阶段会处于不同的环境中,比如开发环境
、测试环境
、生产环境
,通常不同的环境有不同的前置 URL
、接口参数
等。因环境不同而频繁的更改接口前置 URL 及参数,是非常的麻烦的。有了环境管理
功能,只需在不同的环境
设置不同的前置 URL 及参数,在不同环境中测试时,直接切换环境即可。
2. 快速上手
2.1 打开环境管理
(软件右上角设置形状
的按钮)
2.2 打开环境管理界面后,即可在这里新建
或修改
环境
2.3 添加前置url,全局参数,环境变量
2.3.1 添加前置url
2.3.2 添加环境变量
2.3.3 添加Header全局参数
2.3.4 添加Cookie全局参数
2.4 保存添加后,选择刚刚设置的环境,查看接口请求
3. 功能介绍
- 前置 URL:接口运行时自动添加到接口路径前组成接口实际请求的 URL,如前置 URL 为
https://www.api.com
,接口路径为/pets/123
,那么实际请求的 URL 为https://www.api.com/pets/123
。 - 环境变量:跟随环境切换而发生改变的变量,具体说明可以查看文档 环境变量/全局变量/临时变量。
- 额外参数:当前环境下,给所有接口请求额外加上参数。注:额外参数的参数值可以引用环境变量/全局变量/临时变量。
注意
- 前置 URL 末尾建议
不要
加上斜杠/
,接口设计时 接口路径 建议以斜杠/
起始。 - 如果
接口路径
本身就以http://
或https://
起始,实际发出请求的时候不会
自动加上前置 URL。但通常不建议这么使用。
注意
- 系统内置名为
BASE_URL
的特殊环境变量,其值为当前环境的前置URL
,使用方式{{BASE_URL}}
。 - 如用户手动添加了名为
BASE_URL
的环境变量,则会覆盖掉系统内置BASE_URL
的值。 - 脚本可通过
pm.environment.get('BASE_URL')
方式读取前置URL
。 - 脚本
不能
修改前置URL
,脚本pm.environment.set('BASE_URL','xxx')
会生成一个真正的名为BASE_URL
的环境变量,而不会修改前置URL
。 - Apifox 版本号大于等于
1.0.12
才支持内置BASE_URL
。