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. 選擇想要刪除的環境，在操作列表點擊刪除。