配置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”。
创建环境
- 登录ROMA Connect控制台,在左侧导航栏选择“资源管理”,在实例页面单击实例,进入实例控制台。
- 在左侧的导航栏选择“服务集成 APIC > API策略”,在“环境管理”页签中单击“创建环境”。
- 在创建环境弹窗中配置环境信息,完成后单击“确定”。
- 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。
- 如果需要删除环境,在“操作”列单击“删除”即可。
RELEASE系统环境不能删除;如果环境上存在已发布的API,需要先下线API才能删除环境。删除后将无法恢复,请谨慎操作。
- 用户调用开放的API时,默认是调用RELEASE环境的API。如果要访问其他环境上的API,需要在API请求中添加Header参数“X-Stage”,参数值为环境名。例如要访问环境名为“Develop”上的API,则在API请求的Header参数中添加“X-Stage: Develop”。
表1 环境配置 参数
说明
环境名称
填写环境的名称,根据规划自定义。建议您按照一定的命名规则填写环境名称,方便您快速识别和查找。
支持英文、数字、下划线,且只能以英文开头,长度为3-64个字符。
描述
填写环境的描述信息。
创建环境变量
- 登录ROMA Connect控制台,在左侧导航栏选择“资源管理”,在实例页面单击实例,进入实例控制台。
- 在左侧的导航栏选择“服务集成 APIC > API分组”,在页面中单击API分组的名称进入分组详情页面。
- 在“分组信息”页签的“环境变量”下,“环境”参数选择要添加变量的环境,然后单击“添加环境变量”。
- 在新增变量弹窗中配置环境变量信息,完成后单击“确定”。
- 在实际发送API请求中,环境变量名称与变量值会明文传递,请勿携带隐私信息。
- 控制台的“调试”功能,固定为调试环境,不支持携带环境变量调试。
表2 环境变量配置 参数
说明
变量名称
填写变量的名称,必须与API后端服务信息中定义的环境变量一致。
变量值
填写环境变量的值。
- 创建环境变量成功后,在环境变量列表中显示新创建的变量。
- 如果需要删除环境变量,在“操作”列单击“删除”即可。删除后将无法恢复,请谨慎操作。
- 如果环境变量被修改,需要重新发布API,否则新变量将不生效。
相关文档
您可以发布API到环境,以便API调用者调用。