سياسة OASالتحقق من الصحة

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستند Apigee X. المعلومات

لمحة عن سياسة OASHealthation

تتيح لك سياسة التحقق من صحة مواصفات OpenAPI (التحقّق من مواصفات OpenAPI) التحقّق من الطلب الوارد أو رسالة الردّ وفقًا لمواصفات OpenAPI 3.0 (JSON أو YAML). يمكنك الاطّلاع على القسم ما هو المحتوى الذي تم التحقّق من صحته؟

تحدّد سياسة OASVAST اسم مواصفات OpenAPI التي يجب استخدامها للتحقّق من الصحّة عند تنفيذ الخطوة المرفقة بالسياسة. يتم تخزين مواصفات OpenAPI كمورد في الموقع القياسي التالي ضمن حزمة الخادم الوكيل لواجهة برمجة التطبيقات: apiproxy/resources/oas. يجب أن تحتوي مواصفات OpenAPI على إضافات .json و.yml و.yaml.

أضف مواصفات OpenAPI كمورد إلى حزمة الخادم الوكيل لواجهة برمجة التطبيقات باستخدام واجهة المستخدم أو واجهة برمجة التطبيقات، كما هو موضح في إدارة الموارد.

ما هو المحتوى الذي تم التحقّق من صحته؟

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

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

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

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

يلخّص الجدول التالي محتوى رسالة الاستجابة الذي تم التحقّق من صحته من خلال سياسة OASVAST (التحقّق من مصداقية المعلومات حسب المكوّن).

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

العيّنات

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

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

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

<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 للسياسة.
النوع سلسلة
العنصر الرئيسي <PolicyElement>
العناصر الثانوية لا ينطبق

يستخدم العنصر <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> أيّ سمات أو عناصر فرعية.

<خيارات>

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

القيمة التلقائية 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>

<ValidateMessageBody>

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

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

القيمة التلقائية false
هل هي مطلوبة؟ اختياري
النوع منطقي
العنصر الرئيسي <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، لأنّك ستحتاج عادةً إلى تقييم الطلبات الواردة من تطبيقات العملاء. اضبط القيمة على الرد لتقييم رسائل الرد. يمكنك ضبط القيمة على 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). تتوفّر مخطّطات السياسات كمرجع على GitHub.

رموز الخطأ

يصف هذا القسم رموز الأخطاء ورسائل الخطأ التي يتم عرضها ومتغيرات الأخطاء التي تضبطها 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 المتوافقة

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

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

ملاحظة: يتوافق deepObject مع مَعلمات السلسلة فقط، الصفائف والكائنات المُدمجة غير متاحة. 		مسموح به
متوقف نهائيًا
مثال
أمثلة
المحتوى
كائن المسارات حذف
الحصول
head
خيارات
المعلَمات
التصحيح
نشر
وضع
تتبُّع
المتغيرات 		الخوادم
عنصر نص الطلب app/json
Application/hal+json
Application/x-www-form-urlEncrypt (الكائن encoding غير متوافق)
المحتوى
مطلوب 		app/xml
multipart/form-data
text/plain
text/xml
كائن الاستجابة Application/json
Application/hal+json
Application/x-www-form-urlبسّط (كائن encoding غير متوافق)
content
headers 		تطبيق/xml
روابط
نص/عادي
نص/xml
عنصر الردود رمز حالة HTTP
التلقائي 		لا ينطبق
كائن المخطط $ref
additionalProperties (صيغة العلامة المنطقية فقط)
allOf (يتم تجاهلها إذا كانت قيمة additionalProperties هي false)
anyOf
enum
حصريًا الحدّ/الأدنى
تنسيق
العناصر
الحدّ الأقصى/الحد الأدنى
maxLength/minLength
maxLength/minLength
maxProperties/minProperties
MultipleOf
not
MultipleOf
not
noneable
oneOf

required
oneOf

formats
 متوقف نهائيًا
مثال
للقراءة فقط
كتابة فقط
xml
كائن مخطط الأمان في (header، query) (يتم تجاهلها إذا كان type هو http)
الاسم
النوع (apiKey، http) 		bearerFormat
flows
openIdConnectUrl
scheme
كائن الخادم متغيرات
عنوان URL 		تعريفات الخادم المتعددة

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