更新时间:2022-05-05 GMT+08:00
分享

创建发布环境和环境变量(可选)

概述

环境是指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. 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
  2. 在左侧的导航栏选择“服务集成 APIC > API管理”,在“环境管理”页签中单击“创建环境”。
  3. 在创建环境弹窗中配置环境信息,完成后单击“确定”。
    表1 环境配置

    参数

    配置说明

    环境名称

    填写环境的名称,根据规划自定义。建议您按照一定的命名规则填写环境名称,方便您快速识别和查找。

    描述

    填写环境的描述信息。

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

创建环境变量

  1. 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
  2. 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API分组”页签中单击API分组右侧的“更多 > 变量管理”。
  3. 在页面的“环境”参数中选择要添加变量的环境,然后单击“添加变量”。
  4. 在新增变量弹窗中配置环境变量信息,完成后单击“确定”。
    表2 环境变量配置

    参数

    配置说明

    变量名称

    填写变量的名称,必须与API后端服务信息中定义的环境变量一致。

    变量值

    填写环境变量的值。

分享:

    相关文档

    相关产品

关闭导读