文档首页/ API网关 APIG/ 用户指南/ 开放API/ 配置API的发布环境和环境变量(可选)
更新时间:2024-11-27 GMT+08:00

配置API的发布环境和环境变量(可选)

环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。

环境变量是指在环境上创建的一种变量,该变量固定在环境上。如果API的后端服务信息中定义了环境变量,则需要在环境中添加对应的变量。通过环境变量,可实现同一个API,在不同环境中调用不同的后端服务。

例如创建API时,后端服务请求Path中定义了变量“Path”。在环境1中创建了变量“Path”,变量值“/Stage/test”,则API在发布到环境1时,使用“/Stage/test”代替“Path”,在环境1中调用此API时,后端服务请求Path为“/Stage/test”。在环境2中创建了变量“Path”,变量值“/Stage/AA”,则API在发布到环境2时,使用“/Stage/AA”代替“Path”,在环境2中调用此API时,后端服务请求Path为“/Stage/AA”。

图1 环境变量示意图

创建环境

  1. 进入API网关控制台页面。
  2. 根据实际业务在左侧导航栏上方选择实例。
  1. 在左侧导航栏选择“API管理 > API策略”。
  2. 单击“环境管理”页签。
  1. 单击“创建环境”,填写环境信息。

    表1 环境信息

    参数

    说明

    环境名称

    API环境名称。

    描述

    环境描述信息。

  2. 单击“确定”,创建环境。

    创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。

    用户调用开放的API时,默认是调用RELEASE环境的API。如果要访问其他环境上的API,需要在API请求中添加Header参数“X-Stage”,参数值为环境名。例如要访问环境名为“Develop”上的API,则在API请求的Header参数中添加“X-Stage: Develop”。

创建环境变量

  1. 进入API网关控制台页面。
  1. 根据实际业务在左侧导航栏上方选择实例。
  1. 在左侧导航栏选择“API管理 > API分组”。
  2. 单击分组名称
  3. 单击“分组信息”页签。
  4. 在“环境变量”区域,选择环境。如果未创建环境,可单击“创建环境”创建。
  5. 单击“添加环境变量”,填写变量信息。

    • 在实际发送API请求中,环境变量名称与变量值会明文传递,请勿携带隐私信息。
    • API网关管理控制台的“调试”功能,固定为调试环境,不支持携带环境变量调试。
    表2 新增变量

    参数

    说明

    变量名称

    变量的名称,必须与创建API时定义的变量标识完全相同。

    变量值

    变量路径。

  6. 单击“确定”,创建完成。

后续操作

您可以将API发布到环境,以便API调用者调用。