OASDoğrulama politikası

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

OASValidation politikası hakkında

OASValidation (OpenAPI Specification Validation) politikası, gelen bir istek veya yanıt mesajını OpenAPI 3.0 Specification'a (JSON veya YAML) göre doğrulamanıza olanak tanır. Hangi içerikler doğrulanır? başlıklı makaleyi inceleyin.

OASValidation politikası, politikaya bağlı adım yürütüldüğünde doğrulama için kullanılacak OpenAPI Spesifikasyonu'nun adını belirtir. OpenAPI Specification, API proxy paketindeki şu 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 bileşene göre doğrulanan istek mesajı içeriği özetlenmektedir.

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

Örnekler

Aşağıdaki örneklerde, OASValidation politikasını kullanarak iletileri OpenAPI 3.0 Spesifikasyonu'na göre doğrulamanın bazı yolları 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 Spesifikasyonu 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>

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

<DisplayName> öğesi tüm politikalarda 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ğrulanacak OpenAPI spesifikasyonunu belirtir. Bu dosyayı şuralarda saklayabilirsiniz:

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

Daha fazla bilgi için Kaynakları yönetme başlıklı makaleyi inceleyin.

OpenAPI spesifikasyonunu {oas.resource.url} gibi bir mesaj şablonu kullanarak belirtebilirsiniz. Bu durumda, akış değişkeni oas.resource.url (küme parantezleri içinde) değeri değerlendirilir ve çalışma zamanında yük dizesine yerleştirilir. Daha fazla bilgi için İleti şablonları sayfasına göz atı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.

<Seçenekler>

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ğrulayıp doğrulamayacağını belirtir. İleti gövdesi içeriklerini doğrulamak için true olarak 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ütmenin devam edip etmeyeceğini 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>

İstek içinde OpenAPI spesifikasyonunda tanımlanmamış 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> adlı öğenin alt öğesi)

İstek içinde OpenAPI spesifikasyonunda tanımlanmamış başlık parametreleri varsa politikanın davranışını yapılandırır.

OpenAPI spesifikasyonunda tanımlanmayan üstbilgi parametrelerinin istekte belirtilmesine izin vermek için bu parametreyi true olarak ayarlayın. Aksi takdirde, politika yürütülmesinin başarısız olması 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> adlı öğenin alt öğesi)

OpenAPI Specification'da tanımlanmamış sorgu parametreleri istekte mevcutsa politikanın davranışını yapılandırır.

OpenAPI spesifikasyonunda tanımlanmamış sorgu parametrelerinin istekte belirtilmesine izin vermek için bu parametreyi true olarak ayarlayın. Aksi takdirde, politika yürütülmesinin başarısız olması 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> adlı öğenin alt öğesi)

İstek içinde OpenAPI spesifikasyonunda tanımlanmamış çerez parametreleri varsa politikanın davranışını yapılandırır.

OpenAPI spesifikasyonunda tanımlanmayan çerez parametrelerinin istekte belirtilmesine izin vermek için bu parametreyi true olarak ayarlayın. Aksi takdirde, politika yürütülmesinin başarısız olması 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ü saldırılarına karşı değerlendirilecek JSON mesajı. Bu ayar genellikle request olarak belirlenir. Bunun nedeni, istemci uygulamalarından gelen istekleri genellikle değerlendirmeniz gerekmesidir. Yanıt mesajlarını değerlendirmek için response olarak ayarlayın. Politika istek akışına eklendiğinde istek iletisini, yanıt akışına eklendiğinde ise yanıt iletisini 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ı (.xsd) ile tanımlanır. Referans olarak politika şemaları GitHub'da mevcuttur.

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 Specifications özellikleri

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

İlgili konular

• JSON tehditlerine karşı koruma politikası
• SOAPMessageValidation politikası