环境管理使用文档
面向使用者的操作指南。环境管理用于维护多套执行环境(开发/测试/预发)和团队级全局变量,在 API 测试、API 场景调试时切换生效。 环境与全局变量都是团队维度:同团队所有项目共享。
一、入口
在 API 测试 / 场景调试页面顶栏点「环境配置」按钮,打开环境配置弹窗。
弹窗左侧导航分两个区:
- 全局:全局参数、全局脚本
- 环境:环境列表 + 新建环境
二、环境管理
2.1 新建环境
左侧「新建环境」,填写环境名称后进入详情编辑,包含 5 个 tab:
| Tab | 说明 | 典型用途 |
|---|---|---|
| 环境变量 | key-value 变量表 | host、userId 等,请求中用 ${host} 引用 |
| Cookie | 环境级 Cookie | 自动附加到该环境所有请求 |
| Header | 环境级 Header | 如统一的 X-Tenant-Id |
| 服务 | serve 列表(baseUrl 等) | 请求 URL 的域名来源 |
| 数据库 | 数据库连接配置(可配多个) | SQL 接口的连接来源,调试 SQL 时在环境旁下拉选择(见《API 测试使用文档》SQL 接口章节) |
2.2 复制 / 删除环境
环境列表「更多」菜单:复制生成 原名称_副本;删除为逻辑删除,常规确认即可。
2.3 切换环境
调试页面顶栏的环境选择器切换当前环境。切换后:
- 请求的 baseUrl 取自环境 serve 配置
- 环境变量参与
${var}替换 - 环境 Header/Cookie 自动附加到每个请求
- SQL 接口可选择该环境下配置的数据库连接
三、全局参数
「全局 → 全局参数」四个 tab:
| 类型 | 说明 |
|---|---|
| 全局 Cookie | 团队所有请求自动携带 |
| 全局 Header | 团队所有请求自动携带 |
| 全局变量 | 团队级变量,所有接口可 ${var} 引用 |
| 全局断言 | 自动应用到团队下每个接口的响应校验(如统一校验 code=0) |
每行可单独启用/禁用,禁用后不参与合并。
变量优先级
同名变量覆盖顺序(就近优先):
接口参数 > 环境变量 > 全局变量
四、全局脚本
「全局 → 全局脚本」配置团队级前置/后置脚本,在接口脚本之前/之后执行,可用于统一鉴权、统一日志等。
五、常见问题
- 变量没生效:检查该变量所在行是否被禁用;确认优先级(接口 > 环境 > 全局)——可能被更高层级同名变量覆盖
- 切了环境请求还是发到旧地址:确认请求 URL 用的是环境 serve/baseUrl 而非写死的域名
- 看不到环境配置入口:需要
auto:env:view或auto:globalvar:view权限,找团队管理员分配
