更新时间:2024-07-29 GMT+08:00
创建环境变量
API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。
环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。
当创建API时定义了变量标识,则需要在环境中添加变量。例如创建API时定义了变量名为“Path”,在环境1中创建了变量名“Path”,变量值“/Stage/test”,则API在发布到环境1时,使用“/Stage/test”代替“Path”,API调用者在环境1中调用此API时,后端服务请求Path为“/Stage/test”。在环境2中创建了变量名“Path”,变量值“/Stage/AA”,则API在发布到环境2时,使用“/Stage/AA”代替“Path”,API调用者在环境2中调用此API时,后端服务请求Path为“/Stage/AA”。
图1 环境变量示意图
操作步骤
- 进入API网关控制台页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“API管理 > API分组”。
- 单击分组名称。
- 单击“分组信息”页签。
- 在“环境变量”区域,选择环境。如果未创建环境,可单击“创建环境”创建。
- 单击“添加环境变量”,填写变量信息。
在实际发送API请求中,环境变量名称与变量值会明文传递,请勿携带隐私信息。
表1 新增变量 参数
说明
变量名称
变量的名称,必须与创建API时定义的变量标识完全相同。
变量值
变量路径。
- 单击“确定”,创建完成。
后续操作
创建完环境变量后,您可以将API发布到环境变量所在的环境上,以便API调用者调用。
父主题: API管理