OASValidation নীতি

আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন-এ যান। info

OASValidation নীতি সম্পর্কে

OASValidation (OpenAPI স্পেসিফিকেশন যাচাইকরণ) নীতি আপনাকে OpenAPI 3.0 স্পেসিফিকেশন (JSON বা YAML)-এর সাথে ইনকামিং অনুরোধ বা উত্তর মেসেজ যাচাই করতে দেয়। কোন কন্টেন্ট যাচাই করা হয়? তা দেখুন।

OASValidation নীতি OpenAPI স্পেসিফিকেশনের নাম নির্দিষ্ট করে যা নীতিটি যে ধাপের সাথে সংযুক্ত সেটি কার্যকর করার সময় যাচাইকরণের জন্য ব্যবহার করা হয়। OpenAPI স্পেসিফিকেশন API প্রক্সি বান্ডেলের মধ্যে নিম্নলিখিত স্ট্যান্ডার্ড লোকেশনে রিসোর্স হিসেবে স্টোর করা হয়: apiproxy/resources/oas। OpenAPI স্পেসিফিকেশনে অবশ্যই .json, .yml, .yaml এক্সটেনশন থাকতে হবে।

রিসোর্স ম্যানেজ করুন-এ যেমন বর্ণনা করা হয়েছে, সেই অনুযায়ী UI বা API ব্যবহার করে API প্রক্সি বান্ডেলে রিসোর্স হিসেবে 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>

ম্যানেজমেন্ট UI প্রক্সি এডিটরে অন্য, আরও স্বাভাবিক-শোনা নাম দিয়ে নীতি লেবেল করতে name অ্যাট্রিবিউট ছাড়াও ব্যবহার করুন।

<DisplayName> এলিমেন্ট সব নীতির ক্ষেত্রে প্রযোজ্য।

<DisplayName> এলিমেন্ট নিম্নলিখিত সিনট্যাক্স ব্যবহার করে:

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

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

<DisplayName> এলিমেন্টে কোনও অ্যাট্রিবিউট বা চাইল্ড এলিমেন্ট নেই।

<OASResource>

যাচাই করার জন্য OpenAPI স্পেসিফিকেশন উল্লেখ করে। আপনি এই ফাইলটি স্টোর করতে পারবেন:

• API প্রক্সি বান্ডেলে /apiproxy/resources/oas-এর অধীনে API প্রক্সি স্কোপে
• API প্রক্সি এডিটরের নেভিগেটর ভিউয়ের Resources বিভাগে।

আরও তথ্যের জন্য, রিসোর্স ম্যানেজ করুন দেখুন।

আপনি মেসেজ টেমপ্লেট ব্যবহার করে OpenAPI স্পেসিফিকেশন উল্লেখ করতে পারেন, যেমন {oas.resource.url}। এই ক্ষেত্রে, ফ্লো ভেরিয়েবল 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-এ সেট করা হয়, কারণ আপনাকে সাধারণত ক্লায়েন্ট অ্যাপ থেকে ইনবাউন্ড অনুরোধ মূল্যায়ন করতে হবে। উত্তর মেসেজ মূল্যায়ন করতে উত্তর বিকল্পে সেট করুন। অনুরোধের ফ্লোতে নীতি অ্যাটাচ করা থাকলে অনুরোধের মেসেজ এবং উত্তরের ফ্লোতে নীতি অ্যাটাচ করা থাকলে উত্তরের মেসেজ অটোমেটিক মূল্যায়ন করতে মেসেজ হিসেবে সেট করুন।

<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-এর মাধ্যমে ফেরত আসা ফল্ট কোড ও সমস্যার মেসেজ এবং সেট করা ফল্ট ভেরিয়েবল সম্পর্কে এই বিভাগে বর্ণনা করা হয়েছে। সমস্যা সমাধানের জন্য আপনি যদি ফল্ট রুল ডেভেলপ করেন, তাহলে এই তথ্য জানা আপনার জন্য গুরুত্বপূর্ণ। আরও জানতে, নীতি সংক্রান্ত সমস্যা সম্পর্কে আপনার যা জানা প্রয়োজন এবং ত্রুটি মোকাবেলা করা দেখুন।

রানটাইম সমস্যা

নীতি এক্সিকিউট করার সময় এই সমস্যা হতে পারে।

ডিপ্লয়মেন্ট সংক্রান্ত সমস্যা

এই নীতি থাকা কোনও প্রক্সি আপনি প্রয়োগ করলে, এই সমস্যা হতে পারে।

ফল্ট ভেরিয়েবল

এই নীতি রানটাইমে কোনও সমস্যা ট্রিগার করলে, এইসব ভেরিয়েবল সেট করা হয়। আরও তথ্যের জন্য, নীতি সংক্রান্ত সমস্যার ব্যাপারে আপনার কী জানা প্রয়োজন দেখুন।

কাজ করে এমন OpenAPI স্পেসিফিকেশন ফিচার

OASValidation নীতি OpenAPI স্পেসিফিকেশন ফিচারগুলিকে সমর্থন করে যা নিম্নলিখিত সারণীতে বিভাগ অনুসারে সংক্ষিপ্ত করা হয়েছে। যেসব ফিচার কাজ করে না সেগুলিও তালিকাভুক্ত করা হয়েছে।

সম্পর্কিত বিষয়

• JSON থ্রেট প্রোটেকশন নীতি
• SOAPMessageValidation নীতি