سياسة 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، حسب المكوّن.

المكونات طلب التحقق
المسار الأساسي للتحقّق من المسار الأساسي الذي يحدّده الخادم الوكيل لواجهة برمجة التطبيقات ويتجاهل المسار الأساسي المحدد في مواصفات OpenAPI.
المسار يتم التحقّق من تطابق مسار الطلب (بدون المسار الأساسي) مع أحد أنماط المسارات المحدّدة في مواصفات OpenAPI.
فِعل للتحقّق من تحديد الفعل للمسار في مواصفات OpenAPI.
طلب نص الرسالة
  • للتحقق من وجود نص الرسالة في الطلب، إذا لزم الأمر.
  • اختياريًا، يتم التحقّق من صحة نص الرسالة وفقًا لمخطط نص طلب العملية في مواصفات OpenAPI. ضبط هذا الخيار باستخدام <ValidateMessageBody>

ملاحظة: تتحقّق السياسة من صحة نص رسالة الطلب وفقًا لمواصفات OpenAPI فقط في حال ضبط نوع المحتوى على application/json إذا لم يتم ضبط نوع المحتوى على application/json، سيتم تلقائيًا اجتياز عملية التحقّق من صحة نص رسالة الطلب. (بدون التحقق من صحة المحتوى).

المعلمات
  • للتحقّق من توفُّر المَعلمات المطلوبة في الطلب، بما في ذلك مَعلمات المسار والعنوان وطلب البحث وملفات تعريف الارتباط
  • يتم التحقّق من مطابقة قيم المَعلمات للقيم المحدّدة في مواصفات OpenAPI.
  • اختياريًا، يتم التحقّق مما إذا كانت هناك معلَمات في الطلب لم يتم تحديدها في مواصفات OpenAPI. ضبط هذا الخيار باستخدام <AllowUnspecifiedParameters>

يلخص الجدول التالي محتوى رسالة الرد الذي تم التحقق منه من خلال سياسة OASValidation، حسب المكون.

المكونات التحقّق من صحة الردّ
المسار يتم التحقّق من تطابق مسار الطلب (بدون المسار الأساسي) مع أحد أنماط المسارات المحدّدة في مواصفات OpenAPI.
فِعل للتحقّق من تحديد الفعل للمسار في مواصفات OpenAPI.
نص رسالة الردّ
  • للتحقّق من توفُّر نص الرسالة في الردّ، إذا لزم الأمر.
  • يؤدي هذا الخيار إلى التحقّق من أنّ عناوين الاستجابة في مواصفات OpenAPI مضمَّنة في رسالة الردّ، ومن أنّ قيمة الاستجابة تتطابق مع المخطط.
  • اختياريًا، يتم التحقّق من صحة نص الرسالة وفقًا لمخطط نص استجابة العملية في مواصفات OpenAPI. ضبط هذا الخيار باستخدام <ValidateMessageBody>

نماذج

تعرض الأمثلة التالية بعض الطرق التي يمكنك من خلالها استخدام OASValidation للتحقّق من صحة الرسائل وفقًا لمواصفات OpenAPI 3.0.

التحقق من صحة رسالة الطلب

في المثال التالي، تتحقّق سياسة myoaspolicy من صحة نص رسالة الطلب وفقًا لـ مخطط نص رسالة طلب العملية المحددة في مواصفات my-spec.json OpenAPI. 

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

إذا لم يتوافق نص الرسالة مع مواصفات OpenAPI، سيتم عرض خطأ policies.oasvalidation.Failed.

التحقّق من صحة المَعلمات

يضبط المثال التالي السياسة لتفشل في حال تحديد عنوان أو معلَمة طلب بحث أو ملف تعريف ارتباط في الطلب غير المحدد في مواصفات OpenAPI.

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

القيمة التلقائية انظر علامة تبويب السياسة التلقائية أدناه
هل هو مطلوب؟ مطلوب
النوع عنصر معقد
العنصر الرئيسي timing fixed in amara
العناصر الفرعية <DisplayName>
<OASResource>
<Source>
<Options>
<Source>

البنية

يستخدم العنصر <OASValidation> الصيغة التالية:

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

السياسة التلقائية

يوضّح المثال التالي الإعدادات التلقائية عند إضافة سياسة التحقّق من صحة OAS. إلى التدفق في واجهة مستخدم Apigee:

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

يتضمن هذا العنصر السمات التالية الشائعة لجميع السياسات:

السمة تلقائي مطلوب الوصف
name لا ينطبق مطلوب

الاسم الداخلي للسياسة. يمكن أن تحتوي قيمة السمة name على أحرف وأرقام ومسافات وواصلات وشرطات سفلية ونقاط. ويجب ألا تتجاوز هذه القيمة 255 حرفًا.

اختياريًا، يمكنك استخدام العنصر <DisplayName> لتصنيف السياسة في محرّر الخادم الوكيل لواجهة مستخدم الإدارة باستخدام اسم بلغة مختلفة.
continueOnError false إجراء اختياري يمكنك ضبطها على "خطأ" لعرض رسالة خطأ عند تعذّر تنفيذ إحدى السياسات. ويُعدّ هذا سلوكًا متوقعًا في معظم السياسات. يمكنك ضبط القيمة على "صحيح" للاستمرار في تنفيذ العملية حتى بعد تعذُّر تنفيذ سياسة.
enabled صحيح إجراء اختياري اضبط القيمة على "true" لفرض السياسة. اضبط هذه القيمة على "false" على "إيقاف" السياسة. لن يتم فرض السياسة حتى إذا ظلت مرتبطة بتدفق.
async   false منهي العمل به تم إيقاف هذه السمة نهائيًا.

مرجع العنصر الثانوي

يصف هذا القسم العناصر الثانوية في <OASValidation>.

<DisplayName>

استخدِمه مع السمة name لتصنيف السياسة في لإدارة الخادم الوكيل لواجهة المستخدم باستخدام اسم مختلف وطبيعي أكثر.

يُعدّ العنصر <DisplayName> شائعًا في جميع السياسات.

القيمة التلقائية timing fixed in amara
هل هو مطلوب؟ اختياريّ. إذا لم يتم حذف <DisplayName>، يتم استخدام قيمة يتم استخدام سمة name في السياسة
النوع سلسلة
العنصر الرئيسي &lt;PolicyElement&gt;
العناصر الفرعية لا ينطبق

يستخدم العنصر <DisplayName> الصيغة التالية:

البنية

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

مثال

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

لا يحتوي العنصر <DisplayName> على سمات أو عناصر ثانوية

<OASResource>

تحدّد هذه السياسة مواصفات OpenAPI المطلوب التحقّق منها. يمكنك تخزين هذا الملف:

  • في نطاق الخادم الوكيل لواجهة برمجة التطبيقات ضمن /apiproxy/resources/oas في حزمة الخادم الوكيل لواجهة برمجة التطبيقات
  • في القسم Resources من عرض المستكشف في محرِّر خادم وكيل واجهة برمجة التطبيقات.

لمزيد من المعلومات، يُرجى الاطّلاع على إدارة الموارد.

ويمكنك تحديد مواصفات OpenAPI باستخدام نموذج رسالة، مثل {oas.resource.url}. في هذه الحالة، سيتم تقييم قيمة متغير التدفق oas.resource.url (في الأقواس المعقوفة) واستبدالها في سلسلة حمولة البيانات في وقت التشغيل لمزيد من المعلومات، يُرجى الاطّلاع على نماذج الرسائل.

القيمة التلقائية لا ينطبق
هل هو مطلوب؟ مطلوب
النوع سلسلة
العنصر الرئيسي <OASValidation>
العناصر الفرعية لا ينطبق

البنية

يستخدم العنصر <OASResource> الصيغة التالية:

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

مثال

يشير المثال التالي إلى مواصفات my-spec.yaml المخزَّنة ضمن /apiproxy/resources/oas في حزمة الخادم الوكيل لواجهة برمجة التطبيقات:

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

لا يحتوي العنصر <OASResource> على سمات أو عناصر ثانوية

&lt;Options&gt;

تحدِّد هذه السياسة خيارات السياسة.

القيمة التلقائية timing fixed in amara
هل هو مطلوب؟ اختياري
النوع نوع معقد
العنصر الرئيسي <OASValidation>
العناصر الفرعية <ValidateMessageBody>
<AllowUnspecifiedParameters>

البنية

يستخدم العنصر <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>

&lt;ValidateMessageBody&gt;

تحدِّد هذه السياسة ما إذا كان يجب التحقّق من صحة نص الرسالة وفقًا لمخطط نص طلب العملية في مواصفات OpenAPI. اضبط القيمة على true للتحقّق من صحة محتوى نص الرسالة. اضبط القيمة على false للتحقّق من وجود نص الرسالة فقط.

يمكنك التحكّم في استمرار تنفيذ التدفق بعد حدوث خطأ في عملية التحقّق من خلال ضبط السمة continueOnError للسمة <OASValidation> إلى صحيح.

القيمة التلقائية خطأ
هل هو مطلوب؟ اختياري
النوع منطقي
العنصر الرئيسي <Options>
العناصر الفرعية لا ينطبق

البنية

يستخدم العنصر <ValidateMessageBody> الصيغة التالية:

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

القيمة التلقائية timing fixed in amara
هل هو مطلوب؟ اختياري
النوع نوع معقد
العنصر الرئيسي <Options>
العناصر الفرعية <Header>
<Query>
<Cookie>

البنية

يستخدم العنصر <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>

مثال

يضبط المثال التالي السياسة لتفشل في حال تحديد عنوان أو معلَمة طلب بحث أو ملف تعريف ارتباط في الطلب غير المحدد في مواصفات OpenAPI.

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

لضبط سلوك السياسة في حال توفُّر مَعلمات للعنوان الموجودة في الطلب والتي لم يتم تعريفها في مواصفات OpenAPI.

للسماح بتحديد معلمات الرأس في الطلب التي لم يتم تعريفها في مواصفات OpenAPI، اضبط هذه المَعلمة على true. بخلاف ذلك، يمكنك ضبط هذه المَعلمة على false للتسبب في تعذُّر تنفيذ السياسة.

القيمة التلقائية صحيح
هل هو مطلوب؟ منطقي
النوع نوع معقد
العنصر الرئيسي <AllowUnspecifiedParameters>
العناصر الفرعية لا ينطبق

البنية

يستخدم العنصر <Header> الصيغة التالية:

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

مثال

في ما يلي مثال يضبط السياسة على التعذُّر إذا تم تحديد معلَمة عنوان في الطلب غير مسموح به المحدد في مواصفات OpenAPI.

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

<Query> (تابع لـ <AllowUnspecifiedParameters>)

تضبط هذا الإعداد سلوك السياسة في حال توفُّر مَعلمات طلب بحث. الموجودة في الطلب والتي لم يتم تعريفها في مواصفات OpenAPI.

للسماح بتحديد معلَمات طلب البحث في الطلب التي لم يتم تعريفها في مواصفات OpenAPI، اضبط هذه المَعلمة على true. بخلاف ذلك، يمكنك ضبط هذه المَعلمة على false للتسبب في تعذُّر تنفيذ السياسة.

القيمة التلقائية صحيح
هل هو مطلوب؟ منطقي
النوع نوع معقد
العنصر الرئيسي <AllowUnspecifiedParameters>
العناصر الفرعية لا ينطبق

البنية

يستخدم العنصر <Query> الصيغة التالية:

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

مثال

في ما يلي مثال يجعل السياسة تفشل في حال تحديد معلَمة طلب بحث في الطلب غير المحدد في مواصفات OpenAPI.

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

تضبط هذا الإعداد سلوك السياسة إذا كانت هناك مَعلمات لملفات تعريف الارتباط. الموجودة في الطلب والتي لم يتم تعريفها في مواصفات OpenAPI.

للسماح بتحديد معلمات ملفات تعريف الارتباط في الطلب التي لم يتم تعريفها في مواصفات OpenAPI، اضبط هذه المَعلمة على true. بخلاف ذلك، يمكنك ضبط هذه المَعلمة على false للتسبب في تعذُّر تنفيذ السياسة.

القيمة التلقائية صحيح
هل هو مطلوب؟ منطقي
النوع نوع معقد
العنصر الرئيسي <AllowUnspecifiedParameters>
العناصر الفرعية لا ينطبق

البنية

يستخدم العنصر <Cookie> الصيغة التالية:

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

مثال

في ما يلي مثال يجعل السياسة تفشل في حال تحديد معلَمة طلب بحث في الطلب غير المحدد في مواصفات OpenAPI.

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

<Source>

سيتم تقييم رسالة JSON استنادًا إلى هجمات حمولة JSON. يتم تعيين هذا بشكل شائع على request، إذ عليك عادةً تقييم الطلبات الواردة من تطبيقات العميل. اضبط القيمة على response لتقييم رسائل الردّ. يجب ضبط القيمة على message لتقييم رسالة الطلب تلقائيًا. عندما تكون السياسة مرتبطة بمسار الطلب ورسالة الردّ عندما تكون السياسة مرتبطة بالردّ التدفق.

القيمة التلقائية طلب
هل هو مطلوب؟ اختياري
النوع سلسلة
العنصر الرئيسي <Source>
العناصر الفرعية لا ينطبق

البنية

يستخدم العنصر <Source> الصيغة التالية:

<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). يمكنك الرجوع إلى مخططات السياسات المتوفرة على جيت هب.

رموز الخطأ

يصف هذا القسم رموز الأخطاء ورسائل الخطأ التي يتم عرضها ومتغيرات الأخطاء التي تضبطها Edge عندما تؤدي هذه السياسة إلى ظهور خطأ. هذه المعلومات مهمة لمعرفة ما إذا كنت تعمل على تطوير قواعد للأخطاء للتعامل معها. لمزيد من المعلومات، يمكنك الاطّلاع على المعلومات التي يجب معرفتها عن الأخطاء المتعلقة بالسياسات وأخطاء المعالجة.

أخطاء في وقت التشغيل

يمكن أن تحدث هذه الأخطاء عند تنفيذ السياسة.

رمز الخطأ رموز حالة HTTP السبب
steps.oasvalidation.Failed 500 لا يمكن التحقّق من صحة نص رسالة الطلب بالاستناد إلى مواصفات OpenAPI التي تم توفيرها.
steps.oasvalidation.SourceMessageNotAvailable 500

المتغيّر المحدَّد في العنصر <Source> للسياسة إما خارج النطاق أو لا يمكن حلّه.
steps.oasvalidation.NotMessageVariable 500

تم ضبط العنصر <Source> على متغيّر ليس من نوع message.

أخطاء النشر

يمكن أن تحدث هذه الأخطاء عند نشر خادم وكيل يحتوي على هذه السياسة.

اسم الخطأ السبب
ResourceDoesNotExist مواصفات OpenAPI المُشار إليها في العنصر <OASResource> غير موجودة.
ResourceCompileFailed تحتوي مواصفات OpenAPI المضمّنة في عملية النشر على أخطاء تحول دون تجميعها. ويشير ذلك بشكل عام إلى أنّ المواصفات لم تتوافق مع الإصدار 3.0 من مواصفات OpenAPI.
BadResourceURL لا يمكن معالجة مواصفات OpenAPI المُشار إليها في العنصر <OASResource>. يمكن أن يحدث ذلك إذا لم يكن الملف بتنسيق JSON أو YAML أو لم يتم تحديد عنوان URL للملف بشكل صحيح.

متغيرات الخطأ

ويتم ضبط هذه المتغيّرات عندما تؤدي هذه السياسة إلى ظهور خطأ في وقت التشغيل. لمزيد من المعلومات، اطّلِع على المعلومات التي تحتاج إلى معرفتها عن الأخطاء المتعلقة بالسياسات.

المتغيرات المكان مثال
fault.name="fault_name" fault_name هو اسم الخطأ، كما هو موضَّح في جدول أخطاء وقت التشغيل أعلاه. اسم الخطأ هو الجزء الأخير من رمز الخطأ. fault.name Matches "ResourceDoesNotExist"
oasvalidation.policy_name.failed policy_name هو اسم السياسة التي حدّدها المستخدم التي أدت إلى حدوث الخطأ. oasvalidation.myoaspolicy.failed = true

ميزات مواصفات OpenAPI المتوافقة

تتوافق سياسة OASValidation مع ميزات مواصفات OpenAPI التي يتم تلخيصها في الجدول التالي حسب الفئة. ويتم أيضًا إدراج الميزات غير المتوفّرة.

الفئة معلومات معتمَدة غير متاح
تنسيقات أنواع البيانات منطقية
التاريخ
التاريخ والوقت
مزدوج
بريد إلكتروني
عائم
int32/int64
ipv4/ipv6
md5
Sha1/sha256/sha512
سلسلة
معرّف موارد منتظم (URI)
uri-template
رقم uuid
 برنامج ثنائي
بايت
كلمة المرور
عنصر المميِّز تعيين
propertyName 		لا ينطبق
كائن نوع الوسائط مخطط ترميز
مثال
الأمثلة
عنصر العمليات المَعلمات
requestBody
الردود
الأمان (دعم جزئي) 		طلبات معاودة الاتصال
متوقّف نهائيًا
الخوادم
كائن المَعلمات allowEmptyValue
بوصة (query، header، path)
مطلوب
الردود
مخطط
النمط (deepObject، form، formmatrix، label، pipeDelimited، simple، spaceDelimited)

ملاحظة: يتوافق deepObject مع معلَمات السلسلة فقط. لا يتم دعم الصفائف والكائنات المتداخلة. 		allowReserved
متوقّف نهائيًا
مثال
أمثلة
المحتوى
كائن المسارات حذف
الحصول على
رأس
الخيارات
المَعلمات
تصحيح
مشاركة
وضع
تتبُّع
المتغيّرات 		الخوادم
طلب كائن النص application/json
application/hal+json
application/x-www-form-urlcore (كائن encoding غير متوافق)
المحتوى
مطلوب تحديد خيار 		application/xml
متعدد الأجزاء/form-data
نص/عادي
text/xml
عنصر الردّ application/json
application/hal+json
application/x-www-form-urlcore (كائن encoding غير متوافق)
المحتوى
الرؤوس 		application/xml
الروابط
نص/عادي
text/xml
عنصر الردود تلقائي
رمز حالة HTTP 		لا ينطبق
كائن المخطط $ref
خصائص إضافية (صيغة العلامة المنطقية فقط)
الكل Of (يتم تجاهله إذا كانت additionalProperties هي false)
anyOf
تعداد
exclusiveMaximum/exclusiveMinimum
التنسيق
العناصر
الحد الأقصى/الحد الأدنى
maxItems/minItems
maxLength/minLength
maxProperties/minProperties
multipleOf
ليس
قابل للقيم الفارغة
oneOf
التصميم
المواقع
مطلوب
العنوان
النوع
uniqueItems 		متوقّف نهائيًا
مثال
readOnly
writeOnly
xml
كائن مخطط الأمان في (header، query) (يتم تجاهله إذا كانت قيمة type هي http)
الاسم
النوع (apiKey، http) 		bearerFormat
التدفقات
openIdConnectUrl
خطة
عنصر الخادم url
المتغيّرات 		تعريفات متعددة للخادم

مواضيع ذات صلة