您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
共用流程是可重複使用的功能,與 API Proxy 類似。如果您已熟悉 API Proxy,那麼這項參考的大部分內容應該都不陌生。
若要瞭解如何建構共用流程,請從「可重複使用的共用流程」主題開始。
共用流程組合結構
共用流程組合包含下列設定:
基礎設定 | 主要配置設定。請參閱基礎設定。 |
政策 | 符合 Apigee Edge 政策結構定義的 XML 格式設定檔。請參閱「政策」一文。 |
資源 | 執行自訂邏輯時參照的指令碼、JAR 檔案和 XSLT 檔案。請參閱「資源」。 |
SharedFlows | 這個組合中包含的共用流程。請參閱「共用流程」。 |
上表中的元件是由下列目錄結構中的設定檔定義:
共用流程組合的設定檔和目錄結構
本節說明共用流程組合的設定檔和目錄結構。
基礎設定
基本設定檔位於套件的根目錄。名字是套裝組合的名稱。
/sharedflowbundle/traffic-management-shared.xml
基礎設定會定義共用流程組合的內容,以及追蹤組合修訂版本記錄的資訊。
<SharedFlowBundle revision="2" name="traffic-management-shared"> <ConfigurationVersion majorVersion="4" minorVersion="0"/> <CreatedAt>1478637529218</CreatedAt> <CreatedBy>gladys@example.com</CreatedBy> <Description>Shared flow to moderate API traffic</Description> <DisplayName>traffic-management-shared</DisplayName> <LastModifiedAt>1481573374023</LastModifiedAt> <LastModifiedBy>gladys@example.com</LastModifiedBy> <Policies> <Policy>Auth-Flow-Callout</Policy> <Policy>Extract-Token</Policy> <Policy>Spike-Arrest</Policy> </Policies> <Resources> <Resource>jsc://extract-token.js</Resource> </Resources> <SharedFlows> <SharedFlow>default</SharedFlow> </SharedFlows> </SharedFlowBundle>
基礎設定屬性
名稱 | 說明 | 預設 | 必填與否 |
---|---|---|---|
SharedFlowBundle |
|||
name |
共用流程組合的名稱,在機構中不得重複。名稱中可使用的字元必須遵守下列限制:A-Za-z0-9_- |
不適用 | 是 |
revision |
共用流程組合設定的修訂版本編號。您不需要明確設定修訂版本編號,因為 Apigee Edge 會自動追蹤共用流程的目前修訂版本。 | 不適用 | 否 |
基礎設定元素
名稱 | 說明 | 預設 | 必填與否 |
---|---|---|---|
SharedFlowBundle |
|||
ConfigurationVersion |
這個共用流程符合的共用流程組合設定結構定義版本。目前唯一支援的值為 mainVersion 4 和 secondaryVersion 0。日後可以使用這項設定來推動共用流程組合格式的改進。 | 4.0 | 否 |
CreatedAt 和CreatedBy |
共用流程組合的建立日期/時間 (以 Epoch 紀元時間計算的時間),以及建立該流程的使用者電子郵件地址。 | ||
Description |
共用流程的文字說明。如有提供,說明會顯示在 Edge 管理 UI 中。 | 不適用 | 否 |
DisplayName |
容易理解的名稱可能與共用流程設定的 name 屬性不同。 |
不適用 | 否 |
LastModifiedAt 和LastModifiedBy |
共用流程組合的上次修改日期/時間 (以 Epoch 紀元時間計算),以及修改該流程的使用者電子郵件地址。 | ||
Policies |
這個共用流程 /policies 目錄中的政策清單。您通常只有在使用邊緣管理 UI 建立共用流程時,才會看到這個元素。這只是「資訊清單」設定,旨在讓使用者查看共用流程的內容。 |
不適用 | 否 |
Resources |
這個共用流程 /resources 目錄中的資源 (JavaScript、Python、Java、XSLT) 清單。通常只有在使用邊緣管理 UI 建立共用流程時,才會看到這個元素。這只是「資訊清單」設定,目的是讓使用者查看共用流程的內容。 |
不適用 | 否 |
SharedFlows |
指定這個組合包含的共用流程。 請注意,這個元素目前僅支援一個子項 <SharedFlow>。一個共用流程組合只能新增一個共用流程。 |
不適用 | 是 |
共用流程
/sharedflowbundle/sharedflows/default.xml
SharedFlow 設定定義應執行流程元素的順序。<SharedFlow> 元素的 <Step> 子元素會分別指定序列的一部分,例如對政策的呼叫。
下列 SharedFlow 設定指定要以由上到下的順序執行三項政策 (在管理主控台中由左至右執行),並優先採用滑動式冒險政策,最後再套用資料流呼叫政策。
<SharedFlow name="default"> <Step> <Name>Spike-Arrest</Name> </Step> <Step> <Name>Extract-Token</Name> </Step> <Step> <Name>Auth-Flow-Callout</Name> </Step> </SharedFlow>
共用流程設定屬性
名稱 | 說明 | 預設 | 必填與否 |
---|---|---|---|
SharedFlow |
|||
name |
共用流程的名稱,在機構中不得重複。名稱中可使用的字元必須遵守下列限制:A-Za-z0-9_- |
不適用 | 是 |
revision |
共用流程設定的修訂版本編號。您不需要明確設定修訂版本編號,因為 Apigee Edge 會自動追蹤共用流程的目前修訂版本。 | 不適用 | 否 |
共用流程設定元素
名稱 | 說明 | 預設 | 必填與否 |
---|---|---|---|
SharedFlow |
定義共用流程中的政策順序。 | 不適用 | 是 |
Step |
定義步驟 -- 流程序列中的一個階段。 | 不適用 | 是 |
Name |
指定步驟參照的項目名稱。這個元素的值應與項目的專屬 ID 相同,例如政策的名稱屬性值。 | 不適用 | 是 |
政策
/sharedflowbundle/policies
如同 API Proxy,共用流程組合中的 /policies
目錄包含可附加至套件共用流程的所有政策設定 XML。政策會共用部分元素,但這個子集合可與政策專屬的元素加以進一步擴增。如要進一步瞭解如何設定政策,請參閱所需政策的相關主題。您也可以在政策參考資料總覽中找到這些政策。
資源
/sharedflowbundle/resources
資源是指令碼、程式碼和 XSL 轉換作業,可透過政策附加至共用流程。在管理 UI 中,共用流程編輯器的「Scripts」區段會顯示這些指令碼。
如要瞭解支援的資源類型,請參閱資源檔案。
前往 Apigee 開發人員論壇提問。