API 開發生命週期

本頁適用於 Apigee 和 Apigee 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 代理程式，與實際工作環境中外部應用程式在執行階段存取的 API 代理程式之間，區隔流量。

Apigee 在環境中支援下列部署類型：

類型 說明
Proxy 在 Apigee 開發環境中開發及測試 API Proxy，然後將其部署至 Apigee 整合測試和實際執行環境。請參閱「部署 API Proxy」一文。
封存 在 VS Code 中使用 Apigee 開發及測試可編程 API Proxy。

新增政策

您可以使用 Apigee 政策，不必編寫任何程式碼，即可設定 API 的運作方式。政策就像是模組，可實作特定的有限管理功能。政策的設計目的，是讓您輕鬆可靠地將常見類型的管理功能新增至 API。政策提供安全性、頻率限制、轉換和中介服務等功能，讓您不必自行編寫程式碼並維護這類功能。您也可以編寫自訂指令碼和程式碼 (例如 JavaScript 應用程式)，擴充 API 代理功能，並在 Apigee 政策支援的基本管理功能之上進行創新。如要進一步瞭解 Apigee 政策，請參閱「什麼是政策？」一文。

Apigee 提供多項功能的現成政策，例如流量管理、安全性、中介服務和擴充政策。如要查看 Apigee 中可用的完整政策清單，請參閱「政策參考資料總覽」。

推送至正式環境

您可以選擇要部署 API 的位置。舉例來說，您可以將修訂版本提交至正式環境，讓開發人員開始使用您的 API。同時，您可能會在本機或測試環境中重複執行多個修訂版本，以便新增功能或微調政策。接著，您可以將新修訂版本部署至正式環境，覆寫該環境中的現有修訂版本。使用這種方法，您就能在開發及測試新功能時，隨時為開發人員提供 API 的即時修訂版本。

使用 Apigee API 編寫部署指令碼

Apigee 提供 RESTful API，可讓您將 API 代理程式部署和管理作業整合至貴機構的軟體開發生命週期 (SDLC)。舉例來說，為確保符合安全性、可靠性和一致性要求，Apigee API 的常見用途是編寫可透過程式碼部署 API Proxy 的腳本或程式碼，並在更大規模的自動化流程中將其從一個環境推送至另一個環境。

詳情請參閱 Apigee API。

管理環境資源

環境可提供資料和資源的分隔功能。舉例來說，您可以在 test 和 production 環境中設定不同的快取，且只有在該環境中執行的 API Proxy 才能存取這些快取。此外，在測試環境中核發的 API 金鑰在正式版環境中無效，反之亦然。

如要進一步控管升級作業，建議您只在測試環境中重複執行 API Proxy，並盡可能減少在實際執行環境中部署的 API Proxy 所需的變更。

為此，您必須確保與各環境相關聯的特定資源，以可在 API Proxy 設定中保持靜態的方式進行設定。

  • 鍵/值對應 (KVM)：如果範圍限定為環境，請務必使用命名慣例，讓 API 代理程式能夠儲存資料，且在升級期間無須變更設定。詳情請參閱「使用鍵/值對應」。
  • 目標網址：API Proxy 在測試和正式版中呼叫不同的後端網址是很常見的做法。您可以使用 TargetServer 設定建立不受環境限制的 TargetEndpoint 設定。詳情請參閱
  • ServiceCallout 目標：ServiceCallout 可能會根據環境使用不同的目標，例如測試環境中的 ServiceCallout 會使用示範服務。請參閱服務標示政策。

如要讓 API Proxy 設定不受環境限制，您也可以使用條件式陳述式。您可以使用 environment.name 變數建立的條件式陳述式，在套用政策或導向後端網址之前，評估目前的環境。詳情請參閱「含有流程變數的條件」一文。