API 网关：环境管理

1. 什么是API网关的环境管理

环境管理指的是创建和维护一个支持开发、测试和部署软件的不同阶段所需的各种运行环境。这些环境通常包括测试环境、预发环境和线上环境等。良好的环境管理有助于确保软件的质量、稳定性和安全性，同时提高团队效率。

API网关默认为您提供了三个系统环境：测试（TEST）、预发（PRE）和线上（RELEASE）。同时API网关支持根据您的实际需求创建并使用自定义环境。多环境的支持可以让您在使用一套API配置的情况下根据环境来隔离不同研发阶段的后端服务，提高您的研发效率和对API的管理能力。

在API网关上进行环境管理时，您需要做三步工作：

• （可选）维护自定义环境：通过API网关的环境管理控制台，维护您自己的环境。

• API的后端服务环境：通过设置后端服务，为后端服务的测试、预发、线上或自定义环境分别定义不同值，从而当调用API时，API网关可以调用到不同的后端地址。

• API的前端调用：需要client端显式地指定需要调用哪个环境。目前API网关支持两种方式，一种是为API分组的不同环境绑定不同的域名，另一种方式是在 Header 中增加入参 X-Ca-Stage 的信息。

2. 创建环境

API网关默认提供了三个系统环境：测试（TEST）、预发（PRE）和线上（RELEASE），您可以直接使用这三个环境，或者根据您的研发需求自定义环境。

1. 登录API网关环境管理控制台，查看您当前拥有的环境。

2. 点击创建环境，填写环境名称、环境别名和描述信息。其中环境名称和别名需要全局唯一。

   • 环境名称：支持大写英文和数字，必须以英文开头，长度2-10个字符

   • 别名：环境在API网关中用于展示的自定义名称，支持汉字、英文、数字和下划线，长度2-50字符

   • 描述：环境的描述信息

3. 点击确定后将创建自定义的环境。

3. 使用环境

3.1 API后端服务环境配置

在API网关的使用上，我们推荐通过后端服务来统一管理API的后端业务应用，并支持通过环境来区分不同环境下的后端应用。后端服务的介绍和创建参考使用后端服务提高管理效率中步骤 1 和 2。

3.2 API发布指定环境

创建好后端服务之后，您需要为该后端服务创建API来对外提供服务。创建和调试API的具体步骤可以参考使用后端服务提高管理效率中步骤3、4和5。在API发布阶段，您可以将API发布到测试（TEST）、预发（PRE）和线上（RELEASE）这三个系统环境，也可以发布到自定义的环境。

3.3 使用X-Ca-Stage访问

在API的调试阶段，您可以使用API网关提供的二级域名进行API的调试，并且可以通过在请求Header中设置X-Ca-Stage来指定您要请求的环境。另外，如果您在API所属分组绑定了独立域名，并且绑定时选择的环境为默认，则也可以通过X-Ca-Stage来指定请求的环境。

• 线上环境调用。直接发起API调用，即调用线上环境。

• 预发环境调用。调用预发环境的API，则在调用API时，在Header中增加入参X-Ca-Stage: PRE，即可访问预发环境的API。

• 测试环境调用。调用测试环境的API，则在调用API时，在Header中增加入参X-Ca-Stage: TEST，即可访问测试环境的API。

• 自定义环境调用。调用自定义环境的API，则在调用API时，在Header中增加入参X-Ca-Stage为自定义环境的名称，即可访问自定义环境的API。

3.4 独立域名绑定特定环境

如果您针对每个环境拥有一个独立的域名，并且不希望在调用非线上环境时使用X-Ca-Stage来指定环境。则可以在分组绑定独立域名的时候选择具体的环境。独立域名的绑定可以参考使用自定义域名调用API。

4. 删除环境

1. 登录API网关环境管理控制台，查看您当前拥有的环境。

2. 选择想要删除的环境，在操作列表点击删除。