API 開發生命週期

本頁內容適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

以下各節將摘要說明使用 Apigee 的 API 開發生命週期。

開發 API Proxy

Apigee 支援下列 API Proxy 疊代開發選項:

如要進一步瞭解 API Proxy,請參閱「瞭解 API 和 API Proxy」。

使用 Apigee 進行雲端開發

使用 Apigee 提供的 API Proxy 編輯和偵錯工具,開發 API Proxy。您在處理 API Proxy 時,Apigee 會將設定的疊代項目儲存為修訂版本

部署 API Proxy 時,您會選擇要部署的特定修訂版本。通常您會部署最新修訂版本,並視需要還原至先前的修訂版本。請參閱「部署 API Proxy」。

如要開始使用 Apigee 開發 API Proxy,請參閱「建構簡單的 API Proxy」。

在 VS Code 中使用 Apigee 進行本機開發

在 Visual Studio Code (VS Code) 中使用 Apigee 開發 API Proxy,並透過單元測試和手動測試驗證功能 (例如傳送要求並查看結果)。

完成本機驗證後,請將 API Proxy 設定以封存檔形式部署至 Apigee 環境。請參閱「部署 API Proxy」。

如要開始使用 VS Code 中的 Apigee 在本機開發 API Proxy,請參閱「使用 VS Code 中的 Apigee 建構第一個 API Proxy」。

部署 API Proxy

您會建立環境,用於部署 API Proxy。不同環境之間的區別是任意的,每個環境都只是由一組不同的網路位址 (網址) 識別。目標是提供網域,讓您在向外部開發人員公開 API 前,先建構及驗證 API Proxy。詳情請參閱「關於環境和環境群組」。

將 API 部署至多個環境後,您就能區隔流量,避免在測試環境中處理的 API Proxy,與外部應用程式在實際執行環境中存取的 API Proxy 混用。

Apigee 支援環境中的下列部署類型:

類型 說明
Proxy 在 Apigee 開發環境中開發及測試 API Proxy,然後將其部署至 Apigee 整合測試和正式環境。請參閱「部署 API Proxy」。
封存 在 VS Code 中使用 Apigee 開發及測試可程式化 API Proxy

新增政策

Apigee 可讓您使用政策設定 API 的運作方式,完全不需要編寫程式碼。政策就像模組,可實作特定且有限的管理功能。政策的設計宗旨是讓您輕鬆且可靠地為 API 新增常見的管理功能。政策提供安全防護機制、頻率限制、轉換和中介服務等功能,讓您不必自行編寫及維護這些功能。您也可以編寫自訂指令碼和程式碼 (例如 JavaScript 應用程式),擴充 API Proxy 功能,並在 Apigee 政策支援的基本管理功能基礎上進行創新。如要進一步瞭解 Apigee 政策,請參閱「什麼是政策?」一文。

Apigee 提供各種功能的即用型政策,例如流量管理、安全防護、中介服務和擴充政策。如要查看 Apigee 中可用的完整政策清單,請參閱「政策參考資料總覽」。

升級至正式版

您可以選擇要部署 API 的位置。舉例來說,您可以將修訂版本升級至正式環境,讓開發人員開始使用您的 API。同時,您可能正在本機或測試環境中疊代多個修訂版本,新增功能或微調政策。準備就緒後,您就可以將新修訂版本部署至正式環境,覆寫該環境中的現有修訂版本。使用這個方法,您在開發及測試新功能時,開發人員隨時都能使用 API 的正式修訂版本。

使用 Apigee API 編寫部署作業指令碼

Apigee 提供 RESTful API,可讓您將 API Proxy 部署和管理作業整合至貴機構的軟體開發生命週期 (SDLC)。舉例來說,為確保符合安全性、可靠性和一致性需求,Apigee API 的常見用途是編寫指令碼或程式碼,以程式輔助方式部署 API Proxy,並將其從一個環境升級至另一個環境,做為較大型自動化程序的一部分。

詳情請參閱 Apigee API

管理環境資源

環境可區隔資料和資源,舉例來說,您可以在 testproduction 環境中設定不同的快取,這些快取只能由在該環境中執行的 API Proxy 存取。此外,在測試環境中核發的 API 金鑰在正式版環境中無效,反之亦然。

為進一步控管升級程序,建議您只在測試環境中疊代 API Proxy,並盡可能減少對實際執行環境中部署的 API Proxy 進行變更。

如要這麼做,您必須確保與每個環境相關聯的特定資源經過設定,可在 API Proxy 設定中保持靜態。

  • 鍵/值對應 (KVM):如果範圍限定為環境,請務必使用命名慣例,讓 API Proxy 能夠儲存資料,且在升級期間不需要變更設定。詳情請參閱「使用鍵/值對應表」。
  • 目標網址:API Proxy 通常會在測試和正式環境中呼叫不同的後端網址。您可以使用 TargetServer 設定建立與環境無關的 TargetEndpoint 設定。詳情請參閱
  • ServiceCallout 目標:ServiceCallout 可能會根據環境使用不同目標,例如測試環境中的 ServiceCallout 會耗用示範服務。請參閱服務說明政策

如要讓 API Proxy 設定與環境無關,您也可以使用條件陳述式。使用 environment.name 變數建構的條件陳述式,可用於評估目前環境,然後再強制執行政策,或將要求傳送至後端的網址。詳情請參閱「含有流程變數的條件」。