瞭解路徑

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

路由會決定要求從 ProxyEndpoint 到 TargetEndpoint 的路徑。 路徑中包含用於存取 API ProxyEndpoint 的網址,以及 TargetEndpoint 定義的後端服務網址。

觀看這部影片,瞭解路徑簡介,以及 ProxyEndpoint 與 TargetEndpoint 之間的關係。

判斷 API Proxy 端點的網址

下圖顯示應用程式傳送至 ProxyEndpoint 的要求,以及該要求導向後端服務的流程:

在 Edge 上建立 API Proxy 後,應用程式用來存取 Proxy 的預設網址格式如下:

http://{org-name}-{env-name}.apigee.net/{base-path}/{resource-path}

https://{org-name}-{env-name}.apigee.net/{base-path}/{resource-path}

其中:

  • {org-name} 是貴機構的名稱。這個名稱是在 Edge 建立帳戶時建立的。
  • {env-name} 是 Edge 環境名稱。根據預設,在雲端建立的所有 Apigee 機構都會佈建兩個環境:「test」和「prod」。部署 API Proxy 時,您可以選擇部署至一或兩個環境。
  • 建立 API Proxy 時,系統會定義 {base-path}{resource-path}

Edge 收到要求後,會剖析網址,將要求導向正確的 ProxyEndpoint。舉例來說,下列網址用於存取 Edge 上的 API Proxy:

http://myOrg-prod.apigee.net/v1/weather/forecastrss

如果您檢查上圖中 API Proxy 的 ProxyEndpoint 定義,會發現 Edge 如何剖析這個網址:

  1. 網址的網域部分 (http://myOrg-prod.apigee.net) 對應於 Edge 上的虛擬主機。在上述 ProxyEndpoint 定義中,API Proxy 會使用 <VirtualHost> 標記,參照名為「default」的虛擬主機。您可以在環境中定義多個虛擬主機。

    虛擬主機會定義 API Proxy 公開的網域和通訊埠。虛擬主機也會定義 API Proxy 是透過 HTTP 通訊協定存取,還是透過加密的 HTTPS 通訊協定存取。如要詳細瞭解虛擬主機,請參閱「關於虛擬主機 (Beta 版)」。
  2. 網址的第二部分 /v1/weather 是由 ProxyEndpoint 中的 <BasePath> 元素決定。環境的 API Proxy 必須有專屬的基本路徑,因此兩個 API Proxy 不得有相同的基本路徑。
  3. 網址的第三部分 /forecastrss 是由 API Proxy 定義的資源,且具有 <Flows> 標記定義的對應條件式流程。

影片:觀看短片,進一步瞭解 API Proxy 端點。

判斷目標端點的網址

ProxyEndpoint 定義中的 <RouteRule> 標記會決定 API Proxy 的目標,並在處理 ProxyEndpoint 要求中的 PreFlow、條件流程和 PostFlow 的所有政策後進行評估。

ProxyEndpoint 可將目標定義為:

  • 後端服務的直接網址。
  • 單一 TargetEndpoint 定義。
  • 多個 TargetEndpoint,API Proxy 會根據條件將要求委派給目標端點。
  • 空值路徑或目標,表示要求不會轉送至目標。所有要求處理和回應生成作業都會在 Edge 上進行。

影片:觀看短片,進一步瞭解目標端點。

直接網址

ProxyEndpoint 可以直接叫用後端服務,略過任何具名的 TargetEndpoint 設定。舉例來說,下列 <RouteRule> 一律會對 http://api.mycompany.com/myAPI 發出 HTTP 呼叫:

<RouteRule name="default">
  <URL>http://api.mycompany.com/myAPI</URL> 
</RouteRule>

不過,由於沒有 TargetEndpoint,您只能將政策新增至 ProxyEndpoint 定義的流程。

單一目標

在單一目標定義中,ProxyEndpoint 會依名稱參照單一 TargetEndpoint 定義,如上圖所示:

<RouteRule name="default">
  <TargetEndpoint>default</TargetEndpoint>
</RouteRule>

所有對這個 API Proxy 的要求都會導向相同的 TargetEndpoint 定義。TargetEndpoint 中的<URL> 標記會決定後端服務的位置。在上圖中,目標網址為 http://weather.yahooapis.com

條件式目標

<RouteRule> 標記可讓您根據條件,將要求導向目標。您可以根據流程變數、查詢參數、HTTP 標頭、訊息內容或情境資訊 (例如時段和語言代碼),判斷目標端點。舉例來說,您可以在要求網址中加入地理區域,例如美國和英國。接著,您可以根據區域將要求轉送至目標端點。

下列路由規則會評估要求中的 HTTP 標頭。如果 HTTP 標頭 routeTo 的值為 TargetEndpoint1,則要求會轉送至名為 TargetEndpoint1 的 TargetEndpoint。如果不是,要求會轉送至 TargetEndpoint2。

<RouteRule name="MyRoute">
  <Condition>request.header.routeTo = "TargetEndpoint1"</Condition>
  <TargetEndpoint>TargetEndpoint1</TargetEndpoint>
</RouteRule>
<RouteRule name="default">
 <TargetEndpoint>TargetEndpoint2</TargetEndpoint>
</RouteRule>

如果您有多個路徑規則,請建立一個「預設」規則,也就是沒有條件的路徑規則。請務必在條件式路由清單中最後定義預設路由規則,因為系統會在 ProxyEndpoint 中由上而下評估規則。

另請參閱條件式路徑條件參考資料

影片:觀看短片,瞭解如何使用條件式目標,將要求傳送至目標端點。

空值路徑

如果要求訊息不需要轉送至 TargetEndpoint,則可使用空值路徑。如果 ProxyEndpoint 會執行所有必要的處理作業 (例如使用 JavaScript 呼叫外部服務),這項功能就非常實用。

以下範例定義空值路徑:

<RouteRule name="GoNowhere"/>

瞭解詳情