配置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”。
![点击放大](https://support.huaweicloud.com/usermanual-apig/zh-cn_image_0000001178542512.png)
创建环境
- 进入API网关控制台页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“API管理 > API策略”。
- 单击“环境管理”页签。
- 单击“创建环境”,根据下表参数说明,填写环境信息。
表1 环境信息 参数
说明
环境名称
API环境名称。支持英文,数字,下划线,且只能以英文开头,长度为3-64个字符。
描述
环境描述信息。长度为1-255个字符。
- 单击“确定”,创建环境。
创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。
用户调用开放的API时,默认是调用RELEASE环境的API。如果要访问其他环境上的API,需要在API请求中添加Header参数“X-Stage”,参数值为环境名。例如要访问环境名为“Develop”上的API,则在API请求的Header参数中添加“X-Stage: Develop”。
创建环境变量
- 进入API网关控制台页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“API管理 > API分组”。
- 单击分组名称,进入“分组信息”页面。
- 在“环境变量”区域,选择环境。如果未创建环境,可单击“创建环境”创建。
- 单击“添加环境变量”,根据下表参数说明,填写变量信息。
- 在实际发送API请求中,环境变量名称与变量值会明文传递,请勿携带隐私信息。
- API网关管理控制台的“调试”功能,固定为调试环境,不支持携带环境变量调试。
表2 新增变量 参数
说明
变量名称
变量的名称,必须与创建API时定义的变量标识完全相同。在API定义中等于#Name值#部分(区分大小写),发布到环境里的API被变量值替换。
支持英文、数字、英文格式的下划线、中划线,必须以英文字母开头,长度为3-32个字符。
变量值
环境变量的值,支持英文、数字、英文格式的下划线、中划线、斜线、点、冒号,长度为1~255个字符。
- 单击“确定”,创建完成。
后续操作
您可以将API发布到环境,以便API调用者调用。