：環境管理

1. 什麼是API Gateway的環境管理

環境管理指的是建立和維護一個支援開發、測試和部署軟體的不同階段所需的各種運行環境。這些環境通常包括測試環境、預發環境和線上環境等。良好的環境管理有助於確保軟體的品質、穩定性和安全性，同時提高團隊效率。

API Gateway預設為您提供了三個系統內容：測試（TEST）、預發（PRE）和線上（RELEASE）。同時API Gateway支援根據您的實際需求建立並使用自訂環境。多環境的支援可以讓您在使用一套API配置的情況下根據環境來隔離不同研發階段的後端服務，提高您的研發效率和對API的管理能力。

在API Gateway上進行環境管理時，您需要做三步工作：

• （可選）維護自訂環境：通過API Gateway的環境管理主控台，維護您自己的環境。

• API的後端服務環境：通過設定後端服務，為後端服務的測試、預發、線上或自訂環境分別定義不同值，從而當調用API時，API Gateway可以調用到不同的後端地址。

• API的前端調用：需要client端顯式地指定需要調用哪個環境。目前API Gateway支援兩種方式，一種是為API分組的不同環境綁定不同的網域名稱，另一種方式是在 Header 中增加入參 X-Ca-Stage 的資訊。

2. 建立環境

API Gateway預設提供了三個系統內容：測試（TEST）、預發（PRE）和線上（RELEASE），您可以直接使用這三個環境，或者根據您的研發需求自訂環境。

1. 登入API Gateway環境管理主控台，查看您當前擁有的環境。

2. 點擊建立環境，填寫環境名稱、環境別名和描述資訊。其中環境名稱和別名需要全域唯一。

   • 環境名稱：支援大寫英文和數字，必須以英文開頭，長度2-10個字元

   • 別名：環境在API Gateway中用於展示的自訂名稱，支援漢字、英文、數字和底線，長度2-50字元

   • 描述：環境的描述資訊

3. 點擊確定後將建立自訂的環境。

3. 使用環境

3.1 API後端服務環境配置

在API Gateway的使用上，我們推薦通過後端服務來統一管理API的後端業務應用，並支援通過環境來區分不同環境下的後端應用。後端服務的介紹和建立參考使用後端服務提高管理效率中步驟 1 和 2。

3.2 API發布指定環境

建立好後端服務之後，您需要為該後端服務建立API來對外提供服務。建立和調試API的具體步驟可以參考使用後端服務提高管理效率中步驟3、4和5。在API發布階段，您可以將API發布到測試（TEST）、預發（PRE）和線上（RELEASE）這三個系統內容，也發行就緒到自訂的環境。

3.3 使用X-Ca-Stage訪問

在API的調試階段，您可以使用API Gateway提供的次層網域進行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 Gateway環境管理主控台，查看您當前擁有的環境。

2. 選擇想要刪除的環境，在巨集指令清單點擊刪除。