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

您正在查看 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 符合這個共用流程的共用流程組合設定結構定義版本。目前唯一支援的值是 majorVersion 4 和 smallVersion 0。日後可能會使用這項設定來啟用共用流程組合格式。 4.0
CreatedAtCreatedBy 共用流程組合建立的日期/時間 (採用 Epoch 時間),以及建立該套件的使用者電子郵件地址。
Description 共用流程的文字說明。如有提供說明,就會顯示在邊緣管理 UI 中。
DisplayName 容易使用的名稱,可能會與共用流程設定的 name 屬性不同。
LastModifiedAtLastModifiedBy 共用流程組合上次修改的日期/時間 (以 Epoch 時間為準),以及修改該使用者的電子郵件地址的使用者電子郵件地址。
Policies 這個共用流程 /policies 目錄中的政策清單。一般來說,您只有在透過共用管理 UI 建立共用流程時,才會看到這個元素。這只是「資訊清單」設定,旨在讓使用者瞭解共用流程的內容。
Resources 這個共用流程 /resources 目錄中的資源清單 (JavaScript、Python、Java、XSLT)。只有在透過共用管理 UI 建立共用流程時,您才會看到這個元素。這只是「資訊清單」設定,旨在提供共用流程的內容瀏覽權限。
SharedFlows 指定這個組合包含的共用流程。

請注意,這個元素目前僅支援一個子項 <SharedFlow>。一個共用流程組合只能添加一個共用流程。

共用流程

/sharedflowbundle/sharedflows/default.xml

SharedFlow 設定定義了應執行流程元素的順序。<SharedFlow> 元素的 <Step> 子元素會指定每個部分的一部分,例如呼叫政策。

下列 SharedFlow 設定會指定由上而下 (由管理控制台由左至右) 執行的政策,且會先具有 Spike Arrest 政策,最後加上 Flow 摘要政策

<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 轉換。這些動作會顯示在管理使用者介面中共用流程編輯器的「指令碼」部分。

請參閱「資源檔案」,瞭解支援的資源類型。

前往 Apigee 開發人員論壇提問。