API 開發生命週期

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件
資訊

每個機構都有獨特的軟體開發生命週期 (SDLC)。這通常需要 同步處理 API Proxy 部署作業,並與目前用於 開發、測試及部署其他應用程式

API 服務提供工具和符合 REST 樣式的 API,協助您整合 API Proxy 部署作業 提供及管理貴機構的 SDLC。符合 REST 樣式的 API 的常見用途 或程式碼或程式碼 透過程式輔助方式部署 API Proxy 部署到另一個環境,以大型自動化程序的一部分,同時部署或 應用程式。API 服務不就您的 SDLC 做出任何假設, 案件)。而是公開可由開發團隊協調的原子功能, 自動化及最佳化 API 開發生命週期

關於 API 服務 API,請參閱 API 參考資料。詳情請見 取得 API 參考資料 已開始

觀看這部影片,瞭解 API 環境和 API 開發方式 生命週期

環境

Apigee Edge 上的每個機構至少都有兩個可用的部署環境 for API Proxy:「test」和「prod」兩種環境的差異是任意的 :每個環境都能透過一組不同的網路位址 (網址) 識別。 目標是提供一個網域,讓您能在執行 API 之前建立並驗證 API Proxy 公開發布。

您可以利用這些環境,將處理的 API Proxy 開發作業與 SDLC。每個環境都是由網路位址定義,可讓您隔離 目前使用中的 API Proxy,以及應用程式在執行階段存取的 API Proxy。 每個環境可用的網路位址定義於一組 VirtualHosts 中 針對該環境可用的資源

系統會自動為各個環境啟用傳入及伺服器傳輸層安全標準 (TLS)/安全資料傳輸層 (SSL) 功能。有兩個 VirtualHost 這些預先定義選項:defaultsecure。預設值會定義 HTTP 位址,而 Secure 則會定義使用預先設定的伺服器端 TLS/SSL 的 HTTP/S 位址。於 API Proxy 設定,您需要指定 ProxyEndpoint 應監聽的 VirtualHost。 推送至實際工作環境時,通常會移除 default,藉此停用 HTTP 來自 API Proxy 設定的 VirtualHost。

舉例來說,下列 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 準備就緒之前一般而言,請先在以下位置建立 API Proxy test,也就是測試後,升級 prod

若需更多資訊,請參閲 瞭解部署

在測試中疊代開發

使用 API Proxy 時,API 服務會將設定的疊代作業儲存為 修訂版本。在部署 API Proxy 時,您可以選擇要部署的特定修訂版本。 一般而言,您會部署最新的修訂版本,並在必要時還原至先前的版本 修訂版本編號您可以選擇這些修訂版本的部署位置。舉例來說,您可以在單一層級 升級至實際工作環境,讓開發人員開始使用您的 API。但請注意 反覆執行多個測試版本,方便您新增功能或微調政策。接著: 準備就緒後,即可將新的修訂版本部署至實際工作環境,覆寫 目標環境透過這個方法,您就能隨時擁有 API 的即時修訂版本, 與開發人員共同參與

推送至正式環境

完整實作並測試 API Proxy 後,即可升級為「prod」。 系統會使用測試中的 API Proxy 修訂版本覆寫 API Proxy 修訂版本 部署到實際工作環境中

API 服務提供可確保 API Proxy 順暢部署的功能,將 API Proxy 數量降至最低 以及對應用程式和使用者的影響。

指令碼部署

Apigee Edge 管理 UI 可讓您部署 API Proxy,以便直接透過 API 建立 Proxy Proxy 建構工具不過在許多情況下 一致性會要求開發團隊執行指令碼部署程序。如要這麼做, 編寫程式碼和指令碼,叫用 API 服務所公開的 RESTful API。

環境資源

如要在促銷活動期間進一步控管,建議您僅透過 API 疊代 ,並視需求對部署在實際工作環境中的 API Proxy 進行必要變更。

如要這麼做,必須確保與各個環境相關的特定資源都已 因此可在 API Proxy 設定中保持靜態。

  • 目標網址:在測試和測試期間,API Proxy 常會呼叫不同的後端網址 。您可以使用 TargetServer 設定,建立與環境無關的設定 TargetEndpoint 設定。詳情請見 跨後端伺服器負載平衡
  • 快取和鍵/值對應:兩個持續性資源都是以環境為範圍。請 確保 API Proxy 能使用命名慣例來儲存資料, 設定變更。詳情請見 建立及編輯環境快取
  • 服務呼叫目標:服務摘要可能會根據 舉例來說,如果測試環境中的服務呼叫使用示範服務,系統就會產生這則訊息。 請參閱服務呼叫政策

如要獨立設定 API Proxy 設定,您也可以使用條件式 聲明。使用 environment.name 變數建構的條件陳述式可以如下所示: 系統在強制執行政策之前或轉送至 後端。

詳情請參閱瞭解部署作業