流程設定參考資料

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

本節提供用於定義 API Proxy 流程的 XML 元素參考資訊。

階層結構與語法

以下範例顯示流程設定元素的元素階層和語法：

元素階層

以下範例顯示 <ProxyEndpoint> 和 <TargetEndpoint> 元素中的流程設定元素階層：

<ProxyEndpoint | TargetEndpoint>
    <PreFlow>
          <Request>
                <Step>
                    <Condition>
                    <Name>
          <Response>
                <Step>
                    <Condition>
                    <Name>
          <Description>
    <Flows>
          <Flow>
                <Description>
                <Condition>
                <Request>
                      <Step>
                          
                <Response>
                      <Step>
                          
          <Description>
    <PostFlow>
          <Request>
                <Step>
                    
          <Response>
                <Step>
                    
          <Description>
    <PostClientFlow> (<ProxyEndpoint> only)
          <Response>
                
          <Description>

      // Additional configuration elements

</ProxyEndpoint | TargetEndpoint>

語法

以下範例顯示流程設定元素的語法。以下各節將詳細說明這些元素：

<!-- ProxyEndpoint flow configuration file -->
<ProxyEndpoint ... >
  ...
  <PreFlow name="flow_name">
    <Description>flow_description</Description>
    <Request>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Request>
    <Response>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Response>
  </PreFlow>
  <Flows name="flow_name">
    <Flow name="conditional_flow_name">
      <Description>flow_description</Description>
      <Condition>property operator "value"</Condition>
      <Request>
        <Step>
          <Condition>property operator "value"</Condition>
          <Name>policy_name</Name>
        </Step>
        ...
      </Request>
      <Response>
        <Step>
          <Condition>property operator "value"</Condition>
          <Name>policy_name</Name>
        </Step>
        ...
      </Response>
    </Flow>
  </Flows>
  <PostFlow name="flow_name">
    <Description>flow_description</Description>
    <Request>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Request>
    <Response>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Response>
  </PostFlow>
  <PostClientFlow name="flow_name">
    <Description>flow_description</Description>
    <Response>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Response>
  </PostClientFlow>
  ...
</ProxyEndpoint>

<!-- TargetEndpoint flow configuration file -->
<TargetEndpoint ... >
  ...
  <PreFlow name="flow_name">
    <Description>flow_description</Description>
    <Request>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Request>
    <Response>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Response>
  </PreFlow>
  <Flows name="flow_name">
    <Flow name="conditional_flow_name">
      <Description>flow_description</Description>
      <Condition>property operator "value"</Condition>
      <Request>
        <Step>
          <Condition>property operator "value"</Condition>
          <Name>policy_name</Name>
        </Step>
        ...
      </Request>
      <Response>
        <Step>
          <Condition>property operator "value"</Condition>
          <Name>policy_name</Name>
        </Step>
        ...
      </Response>
    </Flow>
    ...
  </Flows>
  <PostFlow name="flow_name">
    <Description>flow_description</Description>
    <Request>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Request>
    <Response>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Response>
  </PostFlow>
  ...
</TargetEndpoint>

您可以使用這些元素定義 PreFlow、條件式流程、PostFlow 和 PostClientFlow 執行作業。

<Condition>

定義在執行階段處理的陳述式。如果陳述式評估為 True，系統就會執行與該條件相關聯的步驟或流程。如果陳述式評估為 false，則系統會忽略該步驟或流程。

類型 字串
父項元素 <Flow>
<Step>
子元素 無

您可以根據該元素是放在 <Flow> 還是 <Step> 元素中，將條件套用至特定步驟或整個流程：

// Condition can apply to just one step:        // Or to the flow:
<Flows>                                         <Flows>
  <Flow>                                          <Flow>
    <Step>                                          <Condition>
      <Condition>                                   <Step>
      <Name>                                          <Name>
      ...                                             ...
    ...                                             ...
  ...                                             ...
</Flows>                                        </Flows>

如果 <Step> 中的條件評估為 True，Edge 就會執行該步驟。如果條件評估結果為 False，Edge 會略過步驟。

如果 <Flow> 中的條件評估為 True，Edge 會處理流程中的所有步驟。如果條件評估結果為 False，Edge 會略過整個資料流。

語法

<Condition> 元素使用下列語法：

<Condition>property operator "value"</Condition>

在此情況下：

property
要在條件中使用的流程變數屬性。舉例來說，request 流程變數包含名為 path 和 content 的屬性。如要在條件中使用，請指定 flow_variable[dot]property_name： 
request.path
request.content

如需流程變數及其屬性的完整清單，請參閱流程變數參考資料。

operator
定義條件評估方式的結構。常見的運算子包括： 
>     greater than           <=    less than or equal to
<     less than              >=    greater than or equal to
=     equals                 &&    and
!=    not equals             ||    or

~~    JavaRegex
~     Matches
/~    MatchesPath

如需完整清單，請參閱「條件」參考資料中的運算子。

"value"
用於評估資料流變數屬性的值。這通常是基本類型，例如整數或字串。例如 200 或「/cat」。此值可包含萬用字元，例如星號和其他字元以比對模式，詳情請參閱「搭配條件式的模式比對」。

範例 1

以下範例會檢查 request 資料流變數的 verb 屬性是否為「GET」：

<!-- api-platform/reference/examples/flow-segments/condition-1.xml -->
<ProxyEndpoint name="default">
  <PreFlow name="my-preFlows">
    <Description>My first PreFlow</Description>
    <Request>
      <Step>
        <Condition>request.verb = "GET"</Condition>
        <Name>Log-Request-OK</Name>
      </Step>
    </Request>
  </PreFlow>
  ...
</ProxyEndpoint>

如果要求是「GET」，這個範例會執行「Log-Request-OK」政策。

範例 2

以下範例會檢查回應代碼：

<!-- api-platform/reference/examples/flow-segments/condition-2.xml -->
<ProxyEndpoint name="default">
  <PreFlow name="my-preFlows">
    <Description>My first PreFlow</Description>
    <Response>
      <Step>
        <Condition>response.status.code LesserThanOrEquals 300</Condition>
        <Name>Log-Response-OK</Name>
      </Step>
      <Step>
        <Condition>response.status.code GreaterThan 300</Condition>
        <Name>Log-Response-NOT-OK</Name>
      </Step>
    </Response>
  </PreFlow>
  ...
</ProxyEndpoint>

視程式碼的值而定，系統會執行不同的政策。

屬性

<Condition> 元素沒有屬性。

子元素

<Condition> 元素沒有子元素。

<Description>

以人類可讀的字詞說明流程。請使用這個元素為自己或其他開發人員提供流程相關資訊。使用者無法看見這項說明。

類型 字串
父項元素 <Flow>
<PreFlow>
<PostFlow>
子元素 無

語法

<Description> 元素使用下列語法：

<Description>flow_description</Description>

範例

以下範例顯示指定資料流用途的 <Description> 元素：

<!-- api-platform/reference/examples/flow-segments/description-1.xml -->
<ProxyEndpoint name="default">
  <Flows name="my-conditional-flows">
    <Flow name="reports">
      <Request>
        <Description>Based on the path suffix, determine which flow to use</Description>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/reports"</Condition>
          <Name>XML-to-JSON-1</Name>
        </Step>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/forecasts"</Condition>
          <Name>XML-to-JSON-1</Name>
        </Step>
      </Request>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

屬性

<Description> 元素沒有屬性。

子元素

<Description> 元素沒有子元素。

<Flow>

定義 Edge 要執行的一組自訂步驟。

類型 複雜的物件
父項元素 <Flows>
子元素 <Condition>
<Description>
<Request>
<Response>

您可以選擇在 <Flow> 上指定 <Condition>。在這種情況下，Edge 只會在條件評估為 true 時執行流程中的步驟。否則 Edge 會略過整個流程。

<Flows> 元素可包含多個 <Flow> 元素，每個元素都有各自的條件和步驟。如有多個 <Flow> 元素，Edge 只會執行沒有條件或條件為 true 的第一個元素。

您可以定義一律執行的預設流程 (如果其他條件式流程都沒有作用)。視 API Proxy 的設定方式而定，這是防範惡意攻擊的實用工具。

語法

<Flow> 元素使用下列語法：

<Flow name="conditional_flow_name">
  <Description>flow_description</Description>
  <Condition>property operator "value"</Condition>
  <Request>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Request>
  <Response>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Response>
</Flow>

<Flow> 的所有子元素皆為選用。

範例 1

以下範例顯示一律執行「Log-Message-OK」政策的簡單 <Flow>：

<!-- api-platform/reference/examples/flow-segments/flow-1.xml -->
<ProxyEndpoint name="default">
  <Flows name="my-flow">
    <Flow>
      <Request>
        <Step>
          <Name>Log-Message-OK</Name>
        </Step>
      </Request>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

範例 2

以下範例顯示的 <Flow> 包含多個步驟，且每個步驟都有各自的條件：

<!-- api-platform/reference/examples/flow-segments/flow-2.xml -->
<ProxyEndpoint name="default">
  <Flows name="my-conditional-flows">
    <Flow name="reports">
      <Request>
        <Description>Based on the path suffix, determine which flow to use</Description>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/reports"</Condition>
          <Name>XML-to-JSON-1</Name>
        </Step>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/forecasts"</Condition>
          <Name>Verify-Auth-1</Name>
        </Step>
      </Request>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

範例 3

以下範例顯示條件式流程中的多個流程：

<!-- api-platform/reference/examples/flow-segments/flows-2.xml -->
<ProxyEndpoint name="default">
  <Flows>
    <Flow name="my-flow-1">
      <Response>
        <Step>
          <Condition>response.status.code = 200</Condition>
          <Name>Assign-Message-1</Name>
        </Step>
      </Response>
    </Flow>
    <Flow name="my-flow-2">
      <Response>
        <Step>
          <Condition>response.status.code >= 400</Condition>
          <Name>Assign-Message-2</Name>
        </Step>
      </Response>
    </Flow>
    <Flow name="my-flow-3">
      <Response>
        <Step>
          <Condition>response.status.code >= 300</Condition>
          <Name>Assign-Message-3</Name>
        </Step>
      </Response>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

邊緣只會執行區隔中的一個資料流；其會執行第一個沒有條件或條件解析為 true 的流程。

屬性

下表說明 <Flow> 元素的屬性：

屬性 類型 說明
name 字串 (必要) 流程的專屬 ID。例如「My-Conditional-Flow-1」。名稱不得包含空格或其他特殊字元。

子元素

下表說明 <Flow> 的子元素：

子元素 類型 說明
<Condition> 字串 定義在執行階段處理的條件陳述式。如果陳述式評估為 True，則會執行資料流 (及其所有步驟)。如果陳述式評估為 false，則系統會忽略資料流 (及其所有步驟)。
<Description> 字串 提供流程的簡短說明。系統不會向外部人員顯示這項說明。
<Request> 複雜物件 指定要求區隔的步驟和條件。
<Response> 複雜的物件 指定回應區隔的步驟和條件。

<Flows>

包含零或多個 <Flow> 元素。

類型 複雜的物件
父項元素 <ProxyEndpoint>
<TargetEndpoint>
子元素 <Flow>

如果 <Flows> 中有多個 <Flow> 元素，則只會執行一個 <Flow>。這會是第一個沒有 <Condition> 的流程，或是條件解析為 true 的流程。

您可以定義一律執行的預設流程 (如果其他流程皆未執行的話)。視 API Proxy 的設定方式而定，這是防範惡意攻擊的實用工具。

語法

<Flows> 元素使用下列語法：

<Flows name="flow_name">
  <Flow name="conditional_flow_name">
    <Description>flow_description</Description>
    <Condition>property operator "value"</Condition>
    <Request>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Request>
    <Response>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Response>
  </Flow>
</Flows>

<Flows> 的所有子元素皆為選用。

範例 1

以下範例是設有單一 <Flow> 的簡易 <Flows> 元素：

<!-- api-platform/reference/examples/flow-segments/flows-1.xml -->
<ProxyEndpoint name="default">
  <Flows name="my-conditional-flows">
    <Flow name="reports">
      <Request>
        <Description>Based on the path suffix, determine which flow to use</Description>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/reports"</Condition>
          <Name>XML-to-JSON-1</Name>
        </Step>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/forecasts"</Condition>
          <Name>Verify-Auth-1</Name>
        </Step>
      </Request>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

邊緣會根據從 proxy 流程變數收集的路徑後置字串，執行其中一項政策。如果路徑後置字串與上述條件皆不相符，則 Edge 不會執行此流程。

範例 2

以下範例顯示 <Flows> 中的多個 <Flow> 元素，每個元素都有專屬的 <Condition>：

<!-- api-platform/reference/examples/flow-segments/flows-2.xml -->
<ProxyEndpoint name="default">
  <Flows>
    <Flow name="my-flow-1">
      <Response>
        <Step>
          <Condition>response.status.code = 200</Condition>
          <Name>Assign-Message-1</Name>
        </Step>
      </Response>
    </Flow>
    <Flow name="my-flow-2">
      <Response>
        <Step>
          <Condition>response.status.code >= 400</Condition>
          <Name>Assign-Message-2</Name>
        </Step>
      </Response>
    </Flow>
    <Flow name="my-flow-3">
      <Response>
        <Step>
          <Condition>response.status.code >= 300</Condition>
          <Name>Assign-Message-3</Name>
        </Step>
      </Response>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

邊緣只會執行條件評估為 true 區隔中的第一個流程。之後，Edge 就會略過區段的其餘流程。

範例 3

以下範例顯示的是「預設」<Flow>：

<!-- api-platform/reference/examples/flow-segments/flows-3.xml -->
<ProxyEndpoint name="default">
  <Flows>
    <Flow name="my-conditional-flow-1">
      <Response>
        <Step>
          <Condition>response.status.code = 200</Condition>
          <Name>Assign-Message-1</Name>
        </Step>
      </Response>
    </Flow>
    <Flow name="my-conditional-flow-2">
      <Response>
        <Step>
          <Condition>response.header.someheader = "42"</Condition>
          <Name>Assign-Message-2</Name>
        </Step>
      </Response>
    </Flow>
    <Flow name="my-default-flow">
      <Response>
        <Step>
          <Name>Assign-Message-3</Name>
        </Step>
      </Response>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

邊緣只會執行條件評估為 true 區隔中的第一個流程。如未執行條件式資料流，則本範例中的第三個資料流會執行 (沒有條件)。

預設流程是防範惡意攻擊的實用工具。

屬性

<Flows> 元素沒有屬性。

子元素

<Flows> 元素包含下列子元素：

子元素 類型 說明
<Flow> 複雜的物件 定義條件式流程中一組可能步驟的流程。

<Name>

指定要在 <Flow> 中執行的政策 ID。

類型 字串
父項元素 <Step>
子元素 無

語法

<Name> 元素使用下列語法：

<Name>policy_name</Name>

範例

以下範例說明透過名稱新增至流程的兩項政策：

<!-- api-platform/reference/examples/flow-segments/name-1.xml -->
<ProxyEndpoint name="default">
  <Flows name="my-conditional-flows">
    <Flow name="reports">
      <Request>
        <Description>Based on the path suffix, determine which flow to use</Description>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/reports"</Condition>
          <Name>XML-to-JSON-1</Name>
        </Step>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/forecasts"</Condition>
          <Name>Verify-Auth-1</Name>
        </Step>
      </Request>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

屬性

<Name> 元素沒有屬性。

子元素

<Name> 元素沒有子元素。

<PostFlow>

定義在要求及回應的 PostFlow 中要採取的步驟。

類型 複雜的物件
父項元素 <ProxyEndpoint>
<TargetEndpoint>
子元素 <Description>
<Request>
<Response>

<PostFlow> 元素使用下列語法：

語法

<PostFlow name="flow_name">
  <Description>flow_description</Description>
  <Request>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Request>
  <Response>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Response>
</PostFlow>

範例

以下範例顯示了 PostFlow，其中已定義要求和回應的步驟：

<!-- api-platform/reference/examples/flow-segments/postflow-1.xml -->
<ProxyEndpoint name="default">
  <PostFlow name="my-postflows">
    <Description>My first PostFlow</Description>
    <Request>
      <Step>
        <Condition>request.verb = "GET"</Condition>
        <Name>Log-Request-OK</Name>
      </Step>
    </Request>
    <Response>
      <Step>
        <Name>Set-Response-Headers</Name>
      </Step>
    </Response>
  </PostFlow>
  ...
</ProxyEndpoint>

屬性

下表說明 <PostFlow> 元素的屬性：

屬性 類型 說明
name 字串 流程的專屬 ID (在端點中不會重複)。例如「My-PostFlow-1」。這個值不得包含空格或其他特殊字元。

子元素

下表說明 <PostFlow> 的子元素：

子元素 類型 說明
<Description> 字串 提供流程的簡短說明。
<Request> 複雜物件 定義要在要求的 PostFlow 期間執行的政策。
<Response> 複雜的物件 定義要在回應的 PostFlow 中執行的政策。

<PostClientFlow>

定義 ProxyEndpoint 中的政策，只有在回應傳回用戶端後才會執行。這類政策通常會記錄與回應相關的訊息。

類型 複雜的物件
父項元素 <ProxyEndpoint>
子元素 <Description>
<Response>

語法

<PostClientFlow> 元素使用下列語法：

<PostClientFlow name="flow_name">
  <Description>flow_description</Description>
  <Response>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Response>
</PostClientFlow>

<PostClientFlow> 的所有子元素皆為選用。

範例

下列範例顯示執行單一政策的簡易 PostClientFlow：

<!-- api-platform/reference/examples/flow-segments/postclientflow-1.xml -->
<ProxyEndpoint name="default">
  <PostClientFlow name="my-postclientflows">
    <Description>My first PostClientFlow. Processed after the response is sent back to the client.</Description>
    <Response>
      <Step>
        <Name>Message-Logging-OK</Name>
      </Step>
    </Response>
  </PostClientFlow>
  ...
</ProxyEndpoint>

屬性

下表說明 <PostClientFlow> 元素的屬性：

屬性 類型 說明
name 字串 流程的專屬 ID。名稱不得包含空格或其他特殊字元。例如「My-PostClientFlow-1」。

子元素

下表說明 <PostClientFlow> 的子元素：

子元素 類型 說明
<Description> 字串 提供流程的簡短說明。
<Response> 複雜的物件 定義要在回應的 PostFlow 中執行的政策。

<PreFlow>

定義要在要求和回應的 PreFlow 中執行的政策。

類型 複雜的物件
父項元素 <ProxyEndpoint>
<TargetEndpoint>
子元素 <Description>
<Request>
<Response>

語法

<PreFlow> 元素使用下列語法：

<PreFlow name="flow_name">
  <Description>flow_description</Description>
  <Request>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Request>
  <Response>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Response>
</PreFlow>

<PreFlow> 的所有子元素皆為選用。

範例

以下範例顯示已定義要求和回應流程的 PreFlow：

<!-- api-platform/reference/examples/flow-segments/preflow-1.xml -->
<ProxyEndpoint name="default">
  <PreFlow name="my-preFlows">
    <Description>My first PreFlow</Description>
    <Request>
      <Step>
        <Condition>request.verb = "GET"</Condition>
        <Name>Log-Request-OK</Name>
      </Step>
    </Request>
    <Response>
      <Step>
        <Condition>response.status.code LesserThanOrEquals 300</Condition>
        <Name>Log-Response-OK</Name>
      </Step>
      <Step>
        <Condition>response.status.code GreaterThan 300</Condition>
        <Name>Log-Response-NOT-OK</Name>
      </Step>
    </Response>
  </PreFlow>
  ...
</ProxyEndpoint>

屬性

下表說明 <PreFlow> 元素的屬性：

屬性 類型 說明
name 字串 流程的專屬 ID。名稱不得包含空格或其他特殊字元。例如「My-PreFlow-1」。

子元素

下表說明 <PreFlow> 的子元素：

子元素 類型 說明
<Description> 字串 提供流程的簡短說明。
<Request> 複雜物件 定義要在要求的 PreFlow 中執行的政策。
<Response> 複雜的物件 定義要在回應 PreFlow 中執行的政策。

<Request>

定義要在流程的要求區段執行的政策。

類型 複雜的物件
父項元素 <Flow>
<PreFlow>
<PostFlow>
子元素 <Condition>
<Step>

語法

<Request> 元素使用下列語法：

<Request>
  <Step>
    <Condition>property operator "value"</Condition>
    <Name>policy_name</Name>
  </Step>
  ...
</Request>

<Request> 的所有子元素皆為選用。

範例

以下範例顯示在 PreFlow 和 PostFlow 中為要求定義的流程：

<!-- api-platform/reference/examples/flow-segments/request-1.xml -->
<ProxyEndpoint name="default">
  <PreFlow name="my-preFlows">
    <Description>My first PreFlow</Description>
    <Request>
      <Step>
        <Condition>request.verb = "GET"</Condition>
        <Name>Log-Request-OK</Name>
      </Step>
    </Request>
  </PreFlow>
  <PostFlow name="my-postflows">
    <Description>My first PostFlow</Description>
    <Request>
      <Step>
        <Condition>request.verb = "GET"</Condition>
        <Name>Log-Request-OK</Name>
      </Step>
    </Request>
  </PostFlow>
  ...
</ProxyEndpoint>

屬性

<Request> 元素沒有屬性。

子元素

下表說明 <Request> 的子元素：

子元素 類型 說明
<Condition> 複雜物件 判斷是否執行要求區隔中的步驟。
<Step> 字串 指定要在要求片段中執行的政策。

<Response>

定義要在流程的回應片段中執行的政策。

類型 複雜的物件
父項元素 <Flow>
<PreFlow>
<PostClientFlow>
<PostFlow>
子元素 <Condition>
<Step>

語法

<Response> 元素使用下列語法：

<Response>
  <Step>
    <Condition>property operator "value"</Condition>
    <Name>policy_name</Name>
  </Step>
  ...
</Response>

<Response> 的所有子元素皆為選用。

範例

以下範例顯示在 PreFlow 和 PostFlow 中為回應定義的流程：

<!-- api-platform/reference/examples/flow-segments/response-1.xml -->
<ProxyEndpoint name="default">
    <PreFlow name="my-preFlows">
        <Description>My first PreFlow</Description>
        <Response>
            <Step>
                <Condition>response.status.code LesserThanOrEquals 300</Condition>
                <Name>Log-Response-OK</Name>
            </Step>
            <Step>
                <Condition>response.status.code GreaterThan 300</Condition>
                <Name>Log-Response-NOT-OK</Name>
            </Step>
        </Response>
    </PreFlow>
    <PostFlow name="my-postflows">
        <Description>My first PostFlow</Description>
        <Response>
            <Step>
                <Name>Set-Response-Headers</Name>
            </Step>
        </Response>
    </PostFlow>
  ...
</ProxyEndpoint>

屬性

<Response> 元素沒有屬性。

子元素

下表說明 <Response> 的子元素：

子元素 類型 說明
<Condition> 字串 判斷是否執行回應區隔中的步驟。
<Step> 字串 指定要在回應片段中執行的政策。

<Step>

指定要執行的政策，以及 (選用) 判斷是否要執行該政策的條件。

類型 複雜的物件
父項元素 <Request>
<Response>
子元素 <Condition>
<Name>

<Flow> 中可以定義多個步驟，並按照流程 XML 中定義的順序執行步驟。

沒有條件的步驟一律會執行。條件是條件為 True 時才會執行的步驟。如果條件評估結果為 False，則 Edge 會略過步驟。

語法

<Step> 元素使用下列語法：

<Step>
  <Condition>property operator "value"</Condition>
  <Name>policy_name</Name>
</Step>

每個 <Step> 只能有一個 <Condition> 和一個 <Name>，但在 <Flow> 中可以有多個步驟。

<Step> 的所有子元素皆為選用。

範例 1

以下範例是包含條件的一個步驟，以及一個沒有條件的步驟：

<!-- api-platform/reference/examples/flow-segments/step-1.xml -->
<ProxyEndpoint name="default">
  <PostFlow name="my-postflows">
      <Description>My first PostFlow</Description>
      <Request>
          <Step>
              <Condition>request.verb = "GET"</Condition>
              <Name>Log-Request-OK</Name>
          </Step>
      </Request>
      <Response>
          <Step>
              <Name>Set-Response-Headers</Name>
          </Step>
      </Response>
  </PostFlow>
  ...
</ProxyEndpoint>

不含條件的步驟會在每次要求區隔期間執行。設有條件的步驟只會在要求在回應片段中為「GET」時執行。

範例 2

以下範例顯示在單一區隔中的多個步驟：

<!-- api-platform/reference/examples/flow-segments/step-2.xml -->
<ProxyEndpoint name="default">
    <PostFlow name="PostFlow">
        <Response>
            <Step>
                <Name>Assign-Message-1</Name>
            </Step>
            <Step>
                <Name>Assign-Message-2</Name>
            </Step>
        </Response>
    </PostFlow>
  ...
</ProxyEndpoint>

沒有條件的步驟一律會執行。

屬性

<Step> 元素沒有屬性。

子元素

下表說明 <Step> 的子元素：

子元素 類型 說明
<Condition> 字串 定義執行階段處理步驟的條件陳述式。如果陳述式評估為 True，則 Edge 會執行步驟。如果陳述式評估為 false，則 Edge 會略過該步驟。
<Name> 字串 指定要在目前流程中執行的政策 ID。