OASDoğrulama politikası

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info

OASValidation politikası hakkında

OASValidation (OpenAPI Spesifikasyonu Doğrulaması) politikası, gelen bir isteği veya yanıt mesajını OpenAPI 3.0 Spesifikasyonu'na (JSON veya YAML) göre doğrulamanızı sağlar. Hangi içerikler doğrulanır? bölümüne bakın.

OASValidation politikası, politikanın eklendiği adım yürütüldüğünde doğrulama için kullanılacak OpenAPI spesifikasyonunun adını belirtir. OpenAPI Specification, API proxy paketindeki aşağıdaki standart konumda kaynak olarak depolanır: apiproxy/resources/oas. OpenAPI spesifikasyonunda .json, .yml, .yaml uzantısı olmalıdır.

Kaynakları yönetme bölümünde açıklandığı gibi, kullanıcı arayüzünü veya API'yi kullanarak bir API proxy paketine kaynak olarak OpenAPI spesifikasyonu ekleyin.

Hangi içerikler doğrulanır?

Aşağıdaki tabloda, OASValidation politikası tarafından doğrulanan istek mesajı içeriği bileşene göre özetlenmiştir.

Aşağıdaki tabloda, OASValidation politikası tarafından doğrulanan yanıt mesajı içeriği bileşene göre özetlenmiştir.

Örnekler

Aşağıdaki örneklerde, mesajları OpenAPI 3.0 spesifikasyonuna göre doğrulamak için OASValidation politikasını kullanabileceğiniz bazı yöntemler gösterilmektedir.

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

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

<OASValidation> öğesi

OpenAPI Specification Doğrulama Politikası'nı tanımlar.

<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>

<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>

Bu öğe, tüm politikalarda ortak olan aşağıdaki özelliklere sahiptir:

Alt öğe referansı

Bu bölümde, <OASValidation> öğesinin alt öğeleri açıklanmaktadır.

<DisplayName>

Yönetim kullanıcı arayüzü proxy düzenleyicisinde politikayı farklı ve daha doğal bir adla etiketlemek için name özelliğine ek olarak kullanın.

<DisplayName> öğesi tüm politikalar için ortaktır.

<DisplayName> öğesi şu söz dizimini kullanır:

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

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

<DisplayName> öğesinin özelliği veya alt öğesi yoktur.

<OASResource>

Doğrulama işleminin hangi OpenAPI spesifikasyonuna göre yapılacağını belirtir. Bu dosyayı şu konumlarda depolayabilirsiniz:

• API proxy paketindeki /apiproxy/resources/oas altındaki API proxy kapsamında
• API proxy düzenleyicisinin Gezgin görünümündeki Resources bölümünde.

Daha fazla bilgi için Kaynakları yönetme bölümüne bakın.

OpenAPI spesifikasyonunu {oas.resource.url} gibi bir mesaj şablonu kullanarak belirtebilirsiniz. Bu durumda, oas.resource.url akış değişkeninin değeri (kurallı parantez içinde) değerlendirilir ve çalışma zamanında yükü dizesiyle değiştirilir. Daha fazla bilgi için Mesaj şablonları bölümüne bakın.

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

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

<OASResource> öğesinin özelliği veya alt öğesi yoktur.

<Options>

Politika seçeneklerini yapılandırır.

<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>

Politikanın, ileti gövdesini OpenAPI Spesifikasyonu'ndaki işlemin istek gövdesi şemasına göre doğrulamasını belirtir. İleti gövdesinin içeriğini doğrulamak için true değerine ayarlayın. Yalnızca ileti gövdesinin varlığını doğrulamak için false olarak ayarlayın.

<OASValidation> öğesinin continueOnError özniteliğini true olarak ayarlayarak doğrulama hatasından sonra akış yürütme işleminin devam edip etmeyeceği kontrol edebilirsiniz.

<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>

İstekte OpenAPI Spesifikasyonu'nda tanımlanmayan başlık, sorgu veya çerez parametreleri varsa politikanın davranışını yapılandırır.

<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>

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

<Header> (<AllowUnspecifiedParameters>'nin alt öğesi)

İstekte OpenAPI spesifikasyonunda tanımlanmayan başlık parametreleri varsa politikanın davranışını yapılandırır.

OpenAPI Spesifikasyonu'nda tanımlanmayan üstbilgi parametrelerinin istekte belirtilmesine izin vermek için bu parametreyi true olarak ayarlayın. Aksi takdirde, politikanın yürütülmesinin başarısız olmasına neden olmak için bu parametreyi false olarak ayarlayın.

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

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

<Query> (<AllowUnspecifiedParameters>'nin alt öğesi)

İstekte OpenAPI Specification'de tanımlanmayan sorgu parametreleri varsa politikanın davranışını yapılandırır.

OpenAPI Spesifikasyonu'nda tanımlanmayan sorgu parametrelerinin istekte belirtilmesine izin vermek için bu parametreyi true olarak ayarlayın. Aksi takdirde, politikanın yürütülmesinin başarısız olmasına neden olmak için bu parametreyi false olarak ayarlayın.

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

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

<Cookie> (<AllowUnspecifiedParameters>'nin alt öğesi)

İstekte OpenAPI Spesifikasyonu'nda tanımlanmayan çerez parametreleri varsa politikanın davranışını yapılandırır.

OpenAPI Spesifikasyonu'nda tanımlanmayan çerez parametrelerinin istekte belirtilmesine izin vermek için bu parametreyi true olarak ayarlayın. Aksi takdirde, politikanın yürütülmesinin başarısız olmasına neden olmak için bu parametreyi false olarak ayarlayın.

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

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

<Source>

JSON yüküne yönelik saldırılara karşı değerlendirilecek JSON mesajı. Genellikle istemci uygulamalarından gelen gelen istekleri değerlendirmeniz gerektiğinden bu ayar genellikle request olarak belirlenir. Yanıt mesajlarını değerlendirmek için response olarak ayarlayın. Politika istek akışına eklendiğinde istek mesajını, politika yanıt akışına eklendiğinde ise yanıt mesajını otomatik olarak değerlendirmek için message olarak ayarlayın.

<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> öğesinin özelliği veya alt öğesi yoktur.

Şemalar

Her politika türü bir XML şemasıyla (.xsd) tanımlanır. Referans olarak kullanabileceğiniz politika şemalarını GitHub'da bulabilirsiniz.

Hata kodları

Bu bölümde, bu politika bir hatayı tetiklediğinde Edge tarafından ayarlanan hata kodları ile hata mesajları ve döndürülen hata mesajları ile Edge tarafından ayarlanan hata değişkenleri açıklanmaktadır. Bu bilgiyi, hataları ele almak için hata kuralları geliştirip geliştirmediğinizi bilmeniz önemlidir. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler ve Hataları işleme bölümlerine bakın.

Çalışma zamanı hataları

Politika yürütüldüğünde bu hatalar ortaya çıkabilir.

Dağıtım hataları

Bu hatalar, bu politikayı içeren bir proxy dağıttığınızda ortaya çıkabilir.

Hata değişkenleri

Bu değişkenler, bu politika çalışma zamanında bir hata tetiklediğinde ayarlanır. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler bölümüne bakın.

Desteklenen OpenAPI Spesifikasyonları özellikleri

OASValidation politikası, aşağıdaki tabloda kategoriye göre özetlenen OpenAPI spesifikasyonu özelliklerini destekler. Desteklenmeyen özellikler de listelenir.

İlgili konular

• JSON Tehdit Koruma Politikası
• SOAPMessageValidation politikası