API 開發生命週期

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

每個機構都有專屬的軟體開發生命週期 (SDLC)。您通常需要同步處理 API Proxy 部署作業，並與您目前用於開發、測試及部署其他應用程式的程序保持一致。

API 服務提供工具和 RESTful API，可讓您將 API Proxy 部署和管理作業整合至貴機構的 SDLC。RESTful API 的常見用途是編寫指令碼或程式碼，以程式輔助方式部署 API Proxy，或將 API Proxy 從一個環境遷移至另一個環境，做為較大型自動化程序的一部分，該程序也會部署或遷移其他應用程式。API 服務不會對您的 SDLC (或任何其他人的 SDLC) 做出任何假設。而是公開可由開發團隊協調的原子函式，以自動化及最佳化 API 開發生命週期。

API 服務 API 的相關文件請參閱 API 參考資料。請參閱 API 參考資料入門指南。

觀看這部影片，瞭解 API 環境和 API 開發生命週期。

環境

Apigee Edge 上的每個機構至少有兩個部署環境可供 API Proxy 使用：「test」和「prod」。這兩個環境的區別是任意的，每個環境都只是由一組不同的網路位址 (網址) 識別。目標是提供網域，讓您在向外部開發人員公開 API 前，先建構及驗證 API Proxy。

您可以利用這些環境，同步處理透過 SDLC 進行的 API Proxy 開發作業。每個環境都由網路位址定義，方便您區隔正在處理的 API Proxy 流量，以及應用程式在執行階段存取的流量。每個環境可用的網路位址，是在該環境可用的 VirtualHost 集中定義。

系統會為每個環境自動啟用伺服器 TLS/SSL。每個環境中都預先定義了兩個 VirtualHost：default 和 secure。「Default」定義 HTTP 位址，「Secure」則定義 HTTP/S 位址，並預先設定伺服器端 TLS/SSL。在 API Proxy 設定中，您會指出 ProxyEndpoint 應監聽哪些 VirtualHost。升級至正式版時，您通常會從 API Proxy 設定中移除 default VirtualHost，藉此停用 HTTP。

舉例來說，下列 ProxyEndpoint 會監聽 HTTP 和 HTTPS。

<HTTPProxyConnection>
  <BasePath>/v0/weather</BasePath>
  <Properties/>
  <VirtualHost>default</VirtualHost>
  <VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>

從 ProxyEndpoint 設定中刪除 default VirtualHost，即可建立僅監聽 HTTPS 而非 HTTP 的 API Proxy。

<HTTPProxyConnection>
  <BasePath>/v0/weather</BasePath>
  <Properties/>
  <VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>

如要查看環境中可用的 VirtualHost，請在管理 UI 主選單中選取「Environments」。

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

將 API Proxy 部署至環境

建立 API Proxy 時，您需要決定要使用的環境。您可以在正式環境中建立新的 API Proxy，但不建議這麼做，因為您可能會在 API 準備就緒前，就將其公開給開發人員。一般來說，請先在 test 中建立 API Proxy，測試後再升級至 prod。

詳情請參閱「瞭解部署作業」。

測試中的疊代開發

您在處理 API Proxy 時，API 服務會將設定的疊代項目儲存為修訂版本。部署 API Proxy 時，您會選擇要部署的特定修訂版本。 一般來說，您會部署最新修訂版本，並視需要還原為先前的修訂版本號碼。您可以選擇要在何處部署這些修訂版本。舉例來說，您可以將修訂版本升級至正式版，讓開發人員開始使用您的 API。同時，您可能正在測試中疊代多個修訂版本，新增功能或微調政策。接著，您就可以將新修訂版本部署至正式環境，覆寫該環境中的現有修訂版本。使用這個方法，您在開發時，開發人員隨時都能取得 API 的即時修訂版本。

升級至實際工作環境

API Proxy 完整實作並經過測試後，即可升級至「prod」。 測試中的 API Proxy 修訂版本會用來覆寫部署在正式環境中的 API Proxy 修訂版本。

API 服務提供相關功能，確保 API 代理程式能順利部署，並在部署程序期間將對應用程式和使用者的影響降到最低。

指令碼部署作業

您可以使用 Apigee Edge 管理 UI，直接從 API Proxy 建構工具將 API Proxy 部署至正式環境。不過，在許多情況下，安全、可靠和一致性的需求會要求開發團隊編寫部署程序指令碼。如要這麼做，您可以編寫程式碼和指令碼，叫用 API 服務公開的 RESTful API。

環境資源

為進一步控管促銷活動期間的 API Proxy，建議您只在測試中疊代 API Proxy，並盡可能減少對已部署至正式環境的 API Proxy 進行變更。

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

  • 目標網址：API Proxy 通常會在測試和正式環境中呼叫不同的後端網址。您可以使用 TargetServer 設定建立與環境無關的 TargetEndpoint 設定。請參閱「在後端伺服器之間進行負載平衡」。
  • 快取和鍵/值對應：這兩種持續性資源的範圍都以環境為限。您應確保使用命名慣例，讓 API Proxy 能夠儲存資料，且在升級期間不必變更設定。請參閱「建立及編輯環境快取」。
  • ServiceCallout 目標：視環境而定，服務號召性用語可能會使用不同的目標。舉例來說，測試環境中的 ServiceCallout 會使用示範服務。請參閱服務呼叫政策。

如要讓 API Proxy 設定與環境無關，也可以使用條件陳述式。使用 environment.name 變數建立條件陳述式，即可在強制執行政策或將流量導向後端網址之前，評估目前的環境。

詳情請參閱「瞭解部署作業」。