环境变量管理

最近更新时间:2020-04-24 16:50:57

环境变量介绍

当前API支持发布至三个环境:测试(dev)、预发布(pre_release)、线上(release),同时API分组管理支持对环境变量进行管理,实现同一个API,在不同环境中调用不同的后端服务。

例如:API测试环境,后端服务对应到您的测试环境资源,从而可以保证在同一套API配置的情况下,供您的测试人员进行测试使用。

在API网关上进行环境管理的时候,您需要做两部分工作:

  1. API的后端配置:通过设置 API分组 的 环境变量 ,为API分组的测试、预发、线上环境分别定义不同值,从而当调用API时,API网关可以调用到不同的后端地址。
  2. API的前端调用:需要client端显式的说明需要调用哪个环境。目前API网关支持在 Header 中增加入参 X-KSCAPIGW-ENV 的信息。

下文将举例介绍后端服务类型为HTTP的情况下, 如何使用在Header 中增加入参 X-KSCAPIGW-ENV方式,从而实现环境变量管理。

操作说明

1.前期准备

准备2个后端服务,使用http访问时,分别会返回{“env”:”test env”}和{“env”:”relese env”}

2.API后端配置

1)在API网关控制台中创建API分组,进入环境变量管理。

2)环境变量管理中,在线上环境和测试环境中分别创建一个同名的变量(本例中为 backend-host ),但值的内容不同,分别1中准备好的2个后端服务地址。

3)在此分组下创建API,略过API的其他定义,重点在 定义API后端服务 的页面中,在 后端服务地址 的位置填写变量名称,填写 #backend-host# 。

4)完成其他API配置后发布到线上环境和测试环境中。

使用X-KSCAPIGW-ENV访问环境

1)线上环境调用。直接发起 API 调用,即调用线上环境。

2)预发环境调用。调用预发环境的API,则在调用API时,在 Header 中增加入参 X-KSCAPIGW-ENV: pre_release, 即可访问预发环境的 API。

3)测试环境调用。调用测试环境的 API,则在调用 API 时,在 Header 中增加入参 X-KSCAPIGW-ENV: dev, 即可访问测试环境的 API。

金山云,开启您的云计算之旅

免费注册