OASपुष्टि करने की नीति

आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी

OASValidation नीति के बारे में जानकारी

OASValidation (OpenAPI स्पेसिफ़िकेशन की पुष्टि) नीति की मदद से, OpenAPI 3.0 स्पेसिफ़िकेशन (JSON या YAML) के ख़िलाफ़, आने वाले अनुरोध या जवाब वाले मैसेज की पुष्टि की जा सकती है. देखें कि किस तरह के कॉन्टेंट की पुष्टि की जाती है?

OASValidation नीति, OpenAPI स्पेसिफ़िकेशन का नाम तय करती है. इसका इस्तेमाल, उस चरण के लिए पुष्टि करने के लिए किया जाता है जिससे यह नीति जुड़ी होती है. OpenAPI स्पेसिफ़िकेशन को एपीआई प्रॉक्सी बंडल में, यहां दी गई स्टैंडर्ड लोकेशन पर एक संसाधन के तौर पर सेव किया जाता है: apiproxy/resources/oas. OpenAPI स्पेसिफ़िकेशन में .json, .yml, .yaml एक्सटेंशन होना चाहिए.

यूज़र इंटरफ़ेस (यूआई) या एपीआई का इस्तेमाल करके, एपीआई प्रॉक्सी बंडल में OpenAPI स्पेसिफ़िकेशन को संसाधन के तौर पर जोड़ें. इसके बारे में संसाधन मैनेज करना लेख में बताया गया है.

किस तरह के कॉन्टेंट की पुष्टि की जाती है?

यहां दी गई टेबल में, अनुरोध के मैसेज के कॉन्टेंट के बारे में खास जानकारी दी गई है. इसे OASValidation नीति के तहत कॉम्पोनेंट के हिसाब से पुष्टि की जाती है.

यहां दी गई टेबल में, कॉम्पोनेंट के हिसाब से जवाब के मैसेज के कॉन्टेंट के बारे में खास जानकारी दी गई है. इस कॉन्टेंट की पुष्टि OASValidation नीति के तहत की जाती है.

सैंपल

यहां दिए गए उदाहरणों में, OpenAPI 3.0 स्पेसिफ़िकेशन के हिसाब से मैसेज की पुष्टि करने के लिए, OASValidation नीति का इस्तेमाल करने के कुछ तरीके बताए गए हैं.

<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> एलिमेंट

यह OpenAPI स्पेसिफ़िकेशन की पुष्टि करने की नीति तय करता है.

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

इस एलिमेंट में ये एट्रिब्यूट शामिल होते हैं, जो सभी नीतियों में शामिल हैं:

चाइल्ड एलिमेंट का रेफ़रंस

इस सेक्शन में, <OASValidation> के चाइल्ड एलिमेंट के बारे में बताया गया है.

<DisplayName>

इस एट्रिब्यूट का इस्तेमाल name एट्रिब्यूट के साथ किया जाता है. इससे, मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) के प्रॉक्सी एडिटर में नीति को लेबल किया जा सकता है. इसके लिए, किसी दूसरे नाम का इस्तेमाल किया जाता है, जो ज़्यादा स्वाभाविक लगता है.

<DisplayName> एलिमेंट, सभी नीतियों में शामिल होता है.

<DisplayName> एलिमेंट में इस सिंटैक्स का इस्तेमाल किया जाता है:

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

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

<DisplayName> एलिमेंट में कोई एट्रिब्यूट या चाइल्ड एलिमेंट नहीं है.

<OASResource>

इससे पता चलता है कि किस OpenAPI स्पेसिफ़िकेशन के हिसाब से पुष्टि करनी है. इस फ़ाइल को यहां सेव किया जा सकता है:

• एपीआई प्रॉक्सी बंडल में /apiproxy/resources/oas के नीचे, एपीआई प्रॉक्सी स्कोप पर
• एपीआई प्रॉक्सी एडिटर के नेविगेटर व्यू के Resources सेक्शन में.

ज़्यादा जानकारी के लिए, संसाधन मैनेज करना लेख पढ़ें.

{oas.resource.url} जैसे मैसेज टेंप्लेट का इस्तेमाल करके, OpenAPI स्पेसिफ़िकेशन तय किया जा सकता है. इस मामले में, फ़्लो वैरिएबल oas.resource.url (घुंघराले ब्रैकेट में) की वैल्यू का आकलन किया जाएगा. साथ ही, इसे रनटाइम के दौरान पेलोड स्ट्रिंग में बदल दिया जाएगा. ज़्यादा जानकारी के लिए, मैसेज टेंप्लेट देखें.

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

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

<OASResource> एलिमेंट में कोई एट्रिब्यूट या चाइल्ड एलिमेंट नहीं है.

<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 पर सेट करके, यह कंट्रोल किया जा सकता है कि पुष्टि से जुड़ी गड़बड़ी के बाद भी फ़्लो का एक्ज़ीक्यूशन जारी रहे या नहीं.

<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 स्पेसिफ़िकेशन में तय नहीं किया गया है.

<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> का बच्चा)

अगर अनुरोध में ऐसे हेडर पैरामीटर मौजूद हैं जो OpenAPI स्पेसिफ़िकेशन में तय नहीं किए गए हैं, तो यह नीति के व्यवहार को कॉन्फ़िगर करता है.

अगर आपको अनुरोध में ऐसे हेडर पैरामीटर तय करने हैं जो OpenAPI स्पेसिफ़िकेशन में तय नहीं किए गए हैं, तो इस पैरामीटर को true पर सेट करें. अगर ऐसा नहीं है, तो इस पैरामीटर को false पर सेट करें, ताकि नीति लागू न हो.

<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> का बच्चा)

यह नीति, अनुरोध में मौजूद उन क्वेरी पैरामीटर के लिए नीति के व्यवहार को कॉन्फ़िगर करती है जिन्हें OpenAPI स्पेसिफ़िकेशन में तय नहीं किया गया है.

अगर आपको अनुरोध में ऐसे क्वेरी पैरामीटर तय करने हैं जिन्हें OpenAPI स्पेसिफ़िकेशन में तय नहीं किया गया है, तो इस पैरामीटर को true पर सेट करें. अगर ऐसा नहीं है, तो इस पैरामीटर को false पर सेट करें, ताकि नीति लागू न हो.

<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> का बच्चा)

यह नीति, कुकी पैरामीटर मौजूद होने पर नीति के व्यवहार को कॉन्फ़िगर करती है. ये पैरामीटर, OpenAPI स्पेसिफ़िकेशन में तय नहीं किए गए हैं.

अगर आपको अनुरोध में ऐसे कुकी पैरामीटर तय करने हैं जिन्हें OpenAPI स्पेसिफ़िकेशन में तय नहीं किया गया है, तो इस पैरामीटर को true पर सेट करें. अगर ऐसा नहीं है, तो इस पैरामीटर को false पर सेट करें, ताकि नीति लागू न हो.

<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 मैसेज, जिसका आकलन JSON पेलोड के हमलों के ख़िलाफ़ किया जाना है. आम तौर पर, इसे request पर सेट किया जाता है, क्योंकि आपको क्लाइंट ऐप्लिकेशन से आने वाले अनुरोधों का आकलन करना होगा. जवाब वाले मैसेज का आकलन करने के लिए, इसे response पर सेट करें. इस विकल्प को message पर सेट करें, ताकि अनुरोध के मैसेज का अपने-आप आकलन हो सके. ऐसा तब होता है, जब नीति को अनुरोध के फ़्लो से जोड़ा जाता है. साथ ही, जवाब के मैसेज का अपने-आप आकलन हो सके. ऐसा तब होता है, जब नीति को जवाब के फ़्लो से जोड़ा जाता है.

<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> एलिमेंट में कोई एट्रिब्यूट या चाइल्ड एलिमेंट नहीं है.

स्कीमा

नीति के हर टाइप को एक्सएमएल स्कीमा (.xsd) से तय किया जाता है. रेफ़रंस के लिए, नीति के स्कीमा GitHub पर उपलब्ध हैं.

गड़बड़ी के कोड

यह सेक्शन गड़बड़ी के कोड और दिखाए गए गड़बड़ी के मैसेज के बारे में बताता है. साथ ही, इस नीति के ट्रिगर होने पर Edge की मदद से सेट की गई गड़बड़ी के वैरिएबल के बारे में बताता है. यह जानकारी जानना ज़रूरी है कि क्या गड़बड़ियों को ठीक करने के लिए, गड़बड़ी से जुड़े नियम बनाए जा रहे हैं. ज़्यादा जानने के लिए, नीति से जुड़ी गड़बड़ियों के बारे में आपके लिए ज़रूरी जानकारी और गड़बड़ियों को ठीक करने के तरीके देखें.

रनटाइम से जुड़ी गड़बड़ियां

नीति के लागू होने पर ये गड़बड़ियां हो सकती हैं.

डिप्लॉयमेंट से जुड़ी गड़बड़ियां

ये गड़बड़ियां तब हो सकती हैं, जब इस नीति वाले किसी प्रॉक्सी को डिप्लॉय किया जाता है.

गड़बड़ी वाले वैरिएबल

ये वैरिएबल तब सेट किए जाते हैं, जब यह नीति रनटाइम के दौरान कोई गड़बड़ी ट्रिगर करती है. ज़्यादा जानकारी के लिए, नीति से जुड़ी गड़बड़ियों के बारे में आपके लिए ज़रूरी जानकारी देखें.

OpenAPI स्पेसिफ़िकेशन की उन सुविधाओं के बारे में जानकारी जिनका इस्तेमाल किया जा सकता है

OASValidation नीति, OpenAPI स्पेसिफ़िकेशन की उन सुविधाओं के साथ काम करती है जिनके बारे में यहां दी गई टेबल में कैटगरी के हिसाब से बताया गया है. साथ ही, उन सुविधाओं के बारे में भी बताया गया है जो काम नहीं करती हैं.

मिलते-जुलते विषय

• JSON थ्रेट प्रोटेक्शन नीति
• SOAPMessageValidation नीति