OAS যাচাইকরণ নীতি

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

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

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

OASValidation নীতিটি ওপেনএপিআই স্পেসিফিকেশনের নাম উল্লেখ করে যেটি পলিসিটি সংযুক্ত করার ধাপটি কার্যকর হলে বৈধতার জন্য ব্যবহার করা হবে। 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>

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, more natural-sounding name.

The <DisplayName> element is common to all policies.

The <DisplayName> element uses the following syntax:

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

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

The <DisplayName> element has no attributes or child elements.

<OASResource>

এর বিরুদ্ধে যাচাই করার জন্য OpenAPI স্পেসিফিকেশন নির্দিষ্ট করে। আপনি এই ফাইল সংরক্ষণ করতে পারেন:

• API প্রক্সি বান্ডেলে /apiproxy/resources/oas এর অধীনে 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> উপাদানটির কোনো বৈশিষ্ট্য বা শিশু উপাদান নেই।

<বিকল্প>

নীতির জন্য বিকল্পগুলি কনফিগার করে৷

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

ওপেনএপিআই স্পেসিফিকেশনে অপারেশনের রিকোয়েস্ট বডি স্কিমার বিরুদ্ধে নীতিটি মেসেজ বডিকে যাচাই করবে কিনা তা নির্দিষ্ট করে। বার্তার মূল বিষয়বস্তু যাচাই করতে সত্যে সেট করুন। বার্তার মূল অংশটি বিদ্যমান তা যাচাই করতে মিথ্যাতে সেট করুন৷

আপনি <OASValidation> উপাদানটির জন্য continueOnError অ্যাট্রিবিউটটিকে সত্যে সেট করে একটি বৈধতা ত্রুটি অনুসরণ করে ফ্লো এক্সিকিউশন চলতে থাকবে কিনা তা নিয়ন্ত্রণ করতে পারেন।

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

ওপেনএপিআই স্পেসিফিকেশনে সংজ্ঞায়িত না থাকা অনুরোধে হেডার, ক্যোয়ারী বা কুকি প্যারামিটার থাকলে নীতির আচরণ কনফিগার করে।

<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> এর সন্তান)

ওপেনএপিআই স্পেসিফিকেশনে সংজ্ঞায়িত না থাকা অনুরোধে হেডার প্যারামিটার থাকলে নীতির আচরণ কনফিগার করে।

ওপেনএপিআই স্পেসিফিকেশনে সংজ্ঞায়িত নয় এমন অনুরোধে হেডার প্যারামিটার নির্দিষ্ট করার অনুমতি দিতে, এই প্যারামিটারটিকে সত্যে সেট করুন। অন্যথায়, নীতি কার্যকর করতে ব্যর্থ হওয়ার জন্য এই প্যারামিটারটিকে মিথ্যাতে সেট করুন।

<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> এর সন্তান )

ওপেনএপিআই স্পেসিফিকেশনে সংজ্ঞায়িত না থাকা অনুরোধে কোয়েরি প্যারামিটার থাকলে নীতির আচরণ কনফিগার করে।

ওপেনএপিআই স্পেসিফিকেশনে সংজ্ঞায়িত নয় এমন অনুরোধে ক্যোয়ারী প্যারামিটার নির্দিষ্ট করার অনুমতি দিতে, এই প্যারামিটারটিকে সত্যে সেট করুন। অন্যথায়, নীতি কার্যকর করতে ব্যর্থ হওয়ার জন্য এই প্যারামিটারটিকে মিথ্যাতে সেট করুন।

<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> এর সন্তান)

ওপেনএপিআই স্পেসিফিকেশনে সংজ্ঞায়িত না থাকা অনুরোধে কুকি প্যারামিটার থাকলে নীতির আচরণ কনফিগার করে।

ওপেনএপিআই স্পেসিফিকেশনে সংজ্ঞায়িত নয় এমন অনুরোধে কুকি প্যারামিটার নির্দিষ্ট করার অনুমতি দিতে, এই প্যারামিটারটিকে সত্যে সেট করুন। অন্যথায়, নীতি কার্যকর করতে ব্যর্থ হওয়ার জন্য এই প্যারামিটারটিকে মিথ্যাতে সেট করুন।

<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 এ উপলব্ধ।

ত্রুটি কোড

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

রানটাইম ত্রুটি

নীতি কার্যকর করার সময় এই ত্রুটিগুলি ঘটতে পারে৷

স্থাপনার ত্রুটি

আপনি যখন এই নীতি সম্বলিত একটি প্রক্সি স্থাপন করেন তখন এই ত্রুটিগুলি ঘটতে পারে৷

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

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

সমর্থিত OpenAPI স্পেসিফিকেশন বৈশিষ্ট্য

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

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

• JSON হুমকি সুরক্ষা নীতি
• SOAPMessage Validation নীতি