共用流程組合設定參考資料

本頁內容適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

共用流程是可重複使用的功能,類似於 API Proxy。詳情請參閱建立可重複使用的共用流程

共用流程組合目錄結構

共用流程套件的目錄結構如下所示,與 API Proxy 設定目錄結構類似。

共用流程組合目錄結構

共用流程組合設定包含下列內容:

基本設定 主要設定。
政策 符合 Apigee 政策結構定義的 XML 格式設定檔。
資源 政策參照的指令碼、JAR 檔案和 XSLT 檔案,用於執行自訂邏輯。
共用流程 這個套件包含共用流程。

基礎設定

基本設定檔位於套件的根目錄。名稱是套裝組合的名稱。

/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 會自動追蹤共用流程的目前修訂版本。 不適用

基本設定元素

名稱 說明 預設 是否必要
SharedFlowBundle
ConfigurationVersion 這個共用流程遵循的共用流程組合設定結構定義版本。目前唯一支援的值是 majorVersion 4minorVersion 0。這項設定日後可用於啟用共用流程套件格式的演進功能。 4.0
CreatedAtCreatedBy 建立共用流程套件的日期/時間 (以 Epoch 時間表示),以及建立者的電子郵件地址。
Description 共用流程的文字說明。如有提供,說明會顯示在 Apigee 使用者介面中。 不適用
DisplayName 方便使用者辨識的名稱,可能與共用流程設定的 name 屬性不同。 不適用
LastModifiedAtLastModifiedBy 上次修改共用流程套件的日期/時間 (以紀元時間表示),以及修改者的電子郵件地址。
Policies 這個共用流程的 /policies 目錄中的政策清單。一般來說,只有使用 Edge 管理使用者介面建立共用流程時,才會看到這個元素。這只是「資訊清單」設定,旨在提供共用流程內容的能見度。 不適用
Resources 這個共用流程的 /resources 目錄中的資源清單 (JavaScript、Python、Java、XSLT)。通常只有在使用 Apigee UI 建立共用流程時,才會看到這個元素。這只是資訊清單設定,旨在提供共用流程內容的瀏覽權限。 不適用
SharedFlows 這個組合包含的共用流程。 不適用

政策

/sharedflowbundle/policies

與 API Proxy 相同,共用流程組合中的 /policies 目錄包含所有政策的設定 XML,可附加至組合中的共用流程。政策會共用部分元素,但這個子集會擴增政策專屬的元素。如要進一步瞭解如何設定政策,請參閱政策參考資料總覽

資源

/sharedflowbundle/resources

資源是可使用政策附加至共用流程的指令碼、程式碼和 XSL 轉換。這些指令碼會顯示在管理 UI 中共用流程編輯器的「指令碼」部分。

如要瞭解支援的資源類型,請參閱「管理資源」。

共用流程

/sharedflowbundle/sharedflows/default.xml

SharedFlow 設定會定義流程元素的執行順序。 <SharedFlow> 元素的 <Step> 子項元素會分別指定序列的一部分,例如對政策的呼叫。

下列 SharedFlow 設定指定要依從上到下 (管理控制台中從左到右) 的順序執行三項政策,其中 SpikeArrest 政策會先執行,FlowCallout 政策則會最後執行。

<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 會自動追蹤共用流程的目前修訂版本。 不適用

共用流程設定元素

名稱 說明 預設 是否必要
SharedFlow 共用流程中的政策順序。 不適用
Step 流程序列中的階段。 不適用
Name 步驟參照的項目名稱。這個元素的值應與項目的專屬 ID 相同,例如政策的名稱屬性值。 不適用