文档首页/ API全生命周期管理 ROMA API/ 用户指南/ API管理/ API服务管理/ 配置环境和环境变量
更新时间：2022-03-18 GMT+08:00
查看PDF
分享

配置环境和环境变量

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

环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个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 环境变量示意图

创建环境

  1. 登录ROMA API控制台。
  2. 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。
  1. 在左侧导航栏选择“API管理 > API服务”。
  2. 在当前应用关联的实例中，根据实际业务选择实例。
  1. 在页面上单击服务名称，进入API服务详情页面。
  2. 在“环境变量”区域，单击“添加环境变量”。

    每个用户最多创建10个环境。

  3. 单击“创建环境”，填写“环境名称”和“描述”。
  4. 单击“确定”，创建完成。

访问环境

通过RESTful API可以访问API默认的RELEASE环境，如果访问其他环境，需要在请求头中添加X-Stage头，内容为环境名。例如访问名为“DEVELOP”的环境，则添加“X-Stage: DEVELOP”。

例如下图所示：

GET /v1/path/apitest HTTP/1.1
Host: service.region.example.com
Content-Type: application/json
x-sdk-date: 20190329T074551Z
X-Stage: DEVELOP

创建环境变量

  1. 登录ROMA API控制台。
  2. 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。
  1. 在左侧导航栏选择“API管理 > API服务”。
  2. 在当前应用关联的实例中，根据实际业务选择实例。
  1. 在页面上单击服务名称，进入API服务详情页面。
  2. 在“环境变量”区域，单击“添加环境变量”，选择待添加变量的环境名称。
  3. 填写变量相关信息，单击“确定”。

    图2 新增变量
    表1 新增变量

    参数

    配置说明

    变量名

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

    变量值

    变量路径。

父主题： API服务管理

相关文档