OASValidation 政策

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

關於 OASValidation 政策

OASValidation (OpenAPI 規格驗證) 政策可讓您根據 OpenAPI 3.0 規格 (JSON 或 YAML)，驗證傳入的要求或回應訊息。 請參閱「哪些內容會經過驗證？」一節。

OASValidation 政策會指定 OpenAPI 規格的名稱，用於在執行附加政策的步驟時進行驗證。OpenAPI 規格會儲存為資源，位於 API Proxy 組合中的下列標準位置：apiproxy/resources/oas。OpenAPI 規格必須有 .json、.yml、.yaml 擴充功能。

使用 UI 或 API，將 OpenAPI 規格做為資源新增至 API Proxy 套件，詳情請參閱「管理資源」。

驗證哪些內容？

下表依元件彙整 OASValidation 政策驗證的要求訊息內容。

元件 提出驗證要求
底層路徑 驗證 API Proxy 定義的基本路徑，並忽略 OpenAPI 規格中指定的基本路徑。
路徑 驗證要求路徑 (不含基本路徑) 是否符合 OpenAPI 規格中定義的其中一個路徑模式。
動詞 驗證 OpenAPI 規格中是否已定義路徑的動詞。
要求郵件內文
  • 驗證要求中是否存在訊息內文 (如有需要)。
  • (選用) 根據 OpenAPI 規格中的作業要求主體結構定義，驗證郵件內文。使用 <ValidateMessageBody> 設定這個選項

注意：只有在 Content-Type 設為 application/json 時，政策才會根據 OpenAPI 規格驗證要求訊息內文。如果內容類型未設為 application/json，要求訊息內文驗證會自動通過 (不會實際驗證內容)。
參數
  • 驗證要求中是否包含必要參數，包括路徑、標頭、查詢和 Cookie 參數。
  • 驗證參數值是否與 OpenAPI 規格中定義的值相符。
  • (選用) 驗證要求中是否存在未在 OpenAPI 規格中定義的參數。 使用 <AllowUnspecifiedParameters> 設定這個選項

下表依元件彙整 OASValidation 政策驗證的回應訊息內容。

元件 回應驗證
路徑 驗證要求路徑 (不含基本路徑) 是否符合 OpenAPI 規格中定義的其中一個路徑模式。
動詞 驗證 OpenAPI 規格中是否已定義路徑的動詞。
回應郵件內文
  • 視需要驗證回應中是否存在郵件內文。
  • 驗證 OpenAPI 規格中的回應標頭是否存在於回應訊息中，以及回應標頭的值是否與結構定義相符。
  • (選用) 根據 OpenAPI 規格中的作業回應主體結構定義，驗證郵件內文。使用 <ValidateMessageBody> 設定這個選項

範例

以下範例說明如何使用 OASValidation 政策，根據 OpenAPI 3.0 規格驗證訊息。

驗證要求訊息

在以下範例中，myoaspolicy 政策會根據 my-spec.json OpenAPI 規格中定義的作業要求訊息內文結構定義，驗證要求訊息的內文。

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.json</OASResource>
   <Options>
      <ValidateMessageBody>true</ValidateMessageBody>
   </Options>
   <Source>request</Source>
</OASValidation>

如果郵件內文不符合 OpenAPI 規格，系統會傳回 policies.oasvalidation.Failed 錯誤。

驗證參數

以下範例會設定政策，如果要求中指定的標頭、查詢或 Cookie 參數未在 OpenAPI 規格中定義，則政策會失敗。

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Header>false</Header>
         <Query>false</Query>
         <Cookie>false</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

<OASValidation> 元素

定義 OpenAPI 規格驗證政策。

預設值 請參閱下方的「預設政策」分頁
必填與否 必填
類型 複雜物件
父項元素 不適用
子元素 <DisplayName>
<OASResource>
<Source>
<Options>
<Source>

語法

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

<OASValidation
  continueOnError="[true|false]"
  enabled="[true|false]"
  name="policy_name"
>
    <!-- All OASValidation child elements are optional except OASResource -->
    <DisplayName>policy_display_name</DisplayName>
    <OASResource>validation_JSON_or_YAML</OASResource>
    <Options>
        <ValidateMessageBody>[true|false]</ValidateMessageBody>
        <AllowUnspecifiedParameters>
            <Header>[true|false]</Header>
            <Query>[true|false]</Query>
            <Cookie>[true|false]</Cookie>
        </AllowUnspecifiedParameters>
    </Options>
    <Source>message_to_validate</Source>
</OASValidation>

預設政策

以下範例顯示在 Apigee UI 中，將 OAS 驗證政策新增至流程時的預設設定：

<OASValidation continueOnError="false" enabled="true" name="OpenAPI-Spec-Validation-1">
    <DisplayName>OpenAPI Spec Validation-1</DisplayName>
    <Properties/>
    <Source>request</Source>
    <OASResource>oas://OpenAPI-Spec-Validation-1.yaml</OASResource>
</OASValidation>

此元素在所有政策中皆包含下列屬性：

屬性 預設 必填與否 Description
name 無 必要

政策的內部名稱。name 屬性的值可以包含英文字母、數字、空格、連字號、底線和半形句號。這個值不得超過 255 個字元。

或者，您也可以使用 <DisplayName> 元素，在管理 UI Proxy 編輯器中，以不同的自然語言名稱來標示政策。
continueOnError false 選填 如果設為「false」，當政策失敗時會傳回錯誤。多數政策預期的行為如下。如果設為「true」，則在政策失敗後，仍會繼續執行流程。
enabled true 選填 設為「true」即可強制執行政策。將政策設為「false」，即可「關閉」政策。即使政策已附加至流程，系統也不會強制執行這項政策。
async   false 已淘汰 這項屬性已淘汰。

子元素參考資料

本節說明 <OASValidation> 的子元素。

<DisplayName>

除了 name 屬性之外，您也可以使用這個屬性，在管理 UI Proxy 編輯器中為政策加上更自然的名稱。

<DisplayName> 元素適用於所有政策。

預設值 不適用
必填與否 (選用步驟) 如果省略 <DisplayName>，系統會使用政策 name 屬性的值
類型 字串
父項元素 <PolicyElement>
子元素 無

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

語法

<PolicyElement>
  <DisplayName>policy_display_name</DisplayName>
  ...
</PolicyElement>

範例

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

<DisplayName> 元素沒有屬性或子元素。

<OASResource>

指定要驗證的 OpenAPI 規格。您可以將這個檔案儲存在：

  • API Proxy 套件中 /apiproxy/resources/oas 下方的 API Proxy 範圍
  • 在 API Proxy 編輯器的「Navigator」檢視畫面中，前往「Resources」部分。

詳情請參閱「管理資源」。

您可以使用訊息範本 (例如 {oas.resource.url}) 指定 OpenAPI 規格。在這種情況下，系統會在執行階段評估流程變數 oas.resource.url (大括號內) 的值，並將其代入酬載字串。詳情請參閱「訊息範本」。

預設值 無
必填與否 必填
類型 字串
父項元素 <OASValidation>
子元素 無

語法

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

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   ...
</OASValidation>

範例

以下範例參照了儲存在 API Proxy 繫結中 /apiproxy/resources/oas 下方的 my-spec.yaml 規格：

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
</OASValidation>

<OASResource> 元素沒有屬性或子元素。

<選項>

設定政策選項。

預設值 不適用
必填與否 選用
類型 複雜類型
父項元素 <OASValidation>
子元素 <ValidateMessageBody>
<AllowUnspecifiedParameters>

語法

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

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
      <ValidateMessageBody>[true|false]</ValidateMessageBody>
      <AllowUnspecifiedParameters>
         <Header>[true|false]</Header>
         <Query>[true|false]</Query>
         <Cookie>[true|false]</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
   ...
</OASValidation>

範例

以下範例會設定政策選項。以下將詳細說明各個選項。

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <ValidateMessageBody>false</ValidateMessageBody>
      <AllowUnspecifiedParameters>
         <Header>false</Header>
         <Query>false</Query>
         <Cookie>false</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

<ValidateMessageBody>

指定政策是否應根據 OpenAPI 規格中的作業要求主體結構定義，驗證郵件內文。設為 true 即可驗證郵件內文內容。設為 false，則只會驗證郵件內文是否存在。

您可以將 <OASValidation> 元素的 continueOnError 屬性設為 true，控制是否在發生驗證錯誤後繼續執行流程。

預設值 false
必填與否 選用
類型 布林值
父項元素 <Options>
子元素 無

語法

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

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
         <ValidateMessageBody>[true|false]</ValidateMessageBody>
   </Options>
   ...
</OASValidation>

範例

以下範例會啟用郵件內文內容驗證：

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <ValidateMessageBody>true</ValidateMessageBody>
   </Options>
</OASValidation>

<AllowUnspecifiedParameters>

如果要求中出現 OpenAPI 規格未定義的標頭、查詢或 Cookie 參數，則設定政策的行為。

預設值 不適用
必填與否 選用
類型 複雜類型
父項元素 <Options>
子元素 <Header>
<Query>
<Cookie>

語法

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

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Header>[true|false]</Header>
         <Query>[true|false]</Query>
         <Cookie>[true|false]</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
   ...
</OASValidation>

範例

以下範例會設定政策，如果要求中指定的標頭、查詢或 Cookie 參數未在 OpenAPI 規格中定義，則政策會失敗。

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Header>false</Header>
         <Query>false</Query>
         <Cookie>false</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

如果要求中出現 OpenAPI 規格未定義的標頭參數，則設定政策的行為。

如要允許在要求中指定未在 OpenAPI 規格中定義的標頭參數，請將這個參數設為 true。否則，請將這個參數設為 false，導致政策執行失敗。

預設值 true
必填與否 布林值
類型 複雜類型
父項元素 <AllowUnspecifiedParameters>
子元素 無

語法

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

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Header>[true|false]</Header>
      </AllowUnspecifiedParameters>
   </Options>
   ...
</OASValidation>

範例

以下範例會設定政策，在要求中指定了 OpenAPI 規格中未定義的標頭參數時失敗。

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Header>false</Header>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

<Query> (<AllowUnspecifiedParameters> 的子項)

如果要求中出現 OpenAPI 規格未定義的查詢參數，則設定政策的行為。

如要允許在要求中指定未在 OpenAPI 規格中定義的查詢參數，請將這個參數設為 true。否則，請將這個參數設為 false，導致政策執行失敗。

預設值 true
必填與否 布林值
類型 複雜類型
父項元素 <AllowUnspecifiedParameters>
子元素 無

語法

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

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Query>[true|false]</Query>
      </AllowUnspecifiedParameters>
   </Options>
   ...
</OASValidation>

範例

以下範例會設定政策，在要求中指定了 OpenAPI 規格未定義的查詢參數時，政策就會失敗。

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Query>false</Query>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

如果要求中出現 OpenAPI 規格未定義的 Cookie 參數，則設定政策的行為。

如要允許在要求中指定未在 OpenAPI 規格中定義的 Cookie 參數，請將這個參數設為 true。否則，請將這個參數設為 false，導致政策執行失敗。

預設值 true
必填與否 布林值
類型 複雜類型
父項元素 <AllowUnspecifiedParameters>
子元素 無

語法

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

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Query>[true|false]</Query>
      </AllowUnspecifiedParameters>
   </Options>
   ...
</OASValidation>

範例

以下範例會設定政策，在要求中指定了 OpenAPI 規格未定義的查詢參數時，政策就會失敗。

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Cookie>false</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

<Source>

要評估是否為 JSON 酬載攻擊的 JSON 訊息。這通常會設為 request，因為您通常需要評估來自用戶端應用程式的傳入要求。設為 response 即可評估回應訊息。設為 message，即可在政策附加至要求流程時自動評估要求訊息，並在政策附加至回應流程時自動評估回應訊息。

預設值 申請。
必填與否 選用
類型 字串
父項元素 <Source>
子元素 無

語法

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

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Source>[message|request|response]</Source>
   ...
</OASValidation>

範例

在下列範例中，如果政策附加至要求流程，系統會自動評估要求訊息；如果政策附加至回應流程，系統則會自動評估回應訊息：

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Source>message</Source>
</OASValidation>

<Source> 元素沒有屬性或子元素。

結構定義

每種政策類型都是由 XML 結構定義 (.xsd) 定義。如需參考資料，請前往 GitHub 取得政策結構定義。

錯誤代碼

本節說明當這項政策觸發錯誤時，傳回的錯誤代碼和錯誤訊息，以及 Edge 設定的錯誤變數。 如果您正在開發錯誤規則來處理錯誤，請務必瞭解這項資訊。詳情請參閱「政策錯誤須知」和「處理錯誤」。

執行階段錯誤

執行政策時，可能會發生這些錯誤。

錯誤代碼 HTTP 狀態 原因
steps.oasvalidation.Failed 500 無法依據所提供的 OpenAPI 規格驗證要求訊息主體。
steps.oasvalidation.SourceMessageNotAvailable 500

你在政策的 <Source> 元素中指定的變數超出範圍，或是無法解析。
steps.oasvalidation.NotMessageVariable 500

<Source> 元素設定為不屬於 message 類型的變數。

部署錯誤

若您部署包含這項政策的 Proxy，就可能會發生這些錯誤。

錯誤名稱 原因
ResourceDoesNotExist <OASResource> 元素中參照的 OpenAPI 規格不存在。
ResourceCompileFailed 部署作業中包含的 OpenAPI 規格含有導致無法編譯的錯誤。這通常表示規格並非格式正確的 OpenAPI 規格 3.0。
BadResourceURL 無法處理 <OASResource> 元素中參照的 OpenAPI 規格。如果檔案並非 JSON 或 YAML 檔案，或是檔案網址未正確指定，就會發生這種情況。

錯誤變數

當這項政策在執行階段觸發錯誤時，系統會設定這些變數。詳情請參閱「政策錯誤須知」。

Variables 地點 範例
fault.name="fault_name" fault_name 是錯誤的名稱，如上方的「執行階段錯誤」表格所示。錯誤名稱是錯誤碼的最後一個部分。 fault.name Matches "ResourceDoesNotExist"
oasvalidation.policy_name.failed policy_name 是擲回錯誤的政策使用者指定的名稱。 oasvalidation.myoaspolicy.failed = true

支援的 OpenAPI 規格功能

OASValidation 政策支援 OpenAPI 規格功能，下表依類別匯總。不支援的功能也會列出。

類別 是否支援 不支援
資料類型格式 boolean
date
date-time
double
email
float
int32/int64
ipv4/ipv6
md5
sha1/sha256/sha512
string
uri
uri-template
uuid
 binary
byte
password
鑑別器物件 mapping
propertyName 		不適用
媒體類型物件 schema encoding
example
examples
Operations 物件 parameters
requestBody
responses
security (部分支援) 		callbacks
deprecated
servers
參數物件 allowEmptyValue
in (query、header、path)
required
responses
schema
style (deepObject、form、formmatrix、label、pipeDelimited、simple、spaceDelimited)

注意： deepObject 僅支援字串參數，不支援陣列和巢狀物件。 		allowReserved
deprecated
example
examples
content
路徑物件 delete
get
head
options
parameters
patch
post
put
trace
variables 		伺服器
要求主體物件 application/json
application/hal+json
application/x-www-form-urlencoded (不支援 encoding 物件)
content
required 		application/xml
multipart/form-data
text/plain
text/xml
回應物件 application/json
application/hal+json
application/x-www-form-urlencoded (不支援 encoding 物件)
content
headers 		application/xml
links
text/plain
text/xml
Responses 物件 預設
HTTP 狀態碼 		不適用
結構定義物件 $ref
additionalProperties (僅限布林值旗標變數)
allOf (如果 additionalProperties 為 false，則會忽略)
anyOf
enum
exclusiveMaximum/exclusiveMinimum
format
items
maximum/minimum
maxItems/minItems
maxLength/minLength
maxProperties/minProperties
multipleOf
not
nullable
oneOf
pattern
properties
required
title
type
uniqueItems 		deprecated
example
readOnly
writeOnly
xml
安全性配置物件 in (header、query) (如果 type 為 http，則忽略)
name
type (apiKey、http) 		bearerFormat
flows
openIdConnectUrl
scheme
伺服器物件 url
variables 		多個伺服器定義

相關主題