كيف تستخدم طريقة HTTP OPTIONS؟

هل تساءلت يومًا ما يمكن أن تفعله واجهة برمجة التطبيقات (API) قبل أن تبدأ في استخدامها؟ هل تريد أن تعرف ما هي الأساليب، والرؤوس، والمعلمات المدعومة من نقطة نهاية معينة؟ في هذه المقالة، سنعرض لك كيفية استخدام طريقة HTTP OPTIONS لاستكشاف أي واجهة برمجة تطبيقات. طريقة HTTP OPTIONS هي واحدة من الطرق الأقل شهرة ولكنها مفيدة جدًا من بروتوكول HTTP. تسمح لك بطلب معلومات حول خيارات الاتصال المتاحة لمورد معين. بعبارة أخرى، تتيح لك أن تسأل واجهة برمجة التطبيقات عما يمكنها القيام به وكيف يمكنها فعله.

يمكن أن يوفر لك استخدام طريقة HTTP OPTIONS الكثير من الوقت والمتاعب عند العمل مع واجهات برمجة التطبيقات. يمكن أن تساعدك في تجنب الأخطاء، وتصحيح المشكلات، وتحسين طلباتك. كما يمكن أن تساعدك أيضًا على اكتشاف ميزات أو وظائف جديدة قد لا تكون على دراية بها بخلاف ذلك.

💡

في هذه المقالة، سنستخدم أداة مجانية ومفتوحة المصدر تُدعى Apidog لنعرض لك كيفية استخدام طريقة HTTP OPTIONS. Apidog هي أداة على الويب تتيح لك التفاعل مع أي واجهة برمجة تطبيقات بطريقة بسيطة وبديهية. يمكنك استخدامها لإرسال الطلبات، وعرض الردود، وفحص الرؤوس. يمكنك أيضًا استخدامها لتوليد مقتطفات من الشفرات، والوثائق، وحالات الاختبار لأي واجهة برمجة تطبيقات.

button

ما هي طريقة HTTP OPTIONS؟

قبل أن نغوص في تفاصيل كيفية استخدام طريقة HTTP OPTIONS، دعنا نفهم أولاً ما هي وكيف تعمل. طريقة HTTP OPTIONS هي واحدة من تسع طرق قياسية من بروتوكول HTTP، جنبًا إلى جنب مع GET، وPOST، وPUT، وPATCH، وDELETE، وHEAD، وTRACE، وCONNECT. لكل طريقة غرض ومعنى محدد، وتستخدم لتنفيذ إجراءات مختلفة على المورد.

تستخدم طريقة HTTP OPTIONS لطلب معلومات حول خيارات الاتصال المتاحة لمورد معين. يمكن أن يكون المورد أي كيان يمكن تحديده بواسطة URI (معرف المورد الموحد)، مثل صفحة ويب، صورة، ملف، أو نقطة نهاية واجهة برمجة التطبيقات. على سبيل المثال، يمثل URI https://api.example.com/users/1 موردًا يتوافق مع مستخدم له معرف 1 في واجهة برمجة التطبيقات الخاصة بـ example.com.

عند إرسال طلب HTTP OPTIONS إلى مورد، فإنك ستسأل الخادم بشكل أساسي: "ماذا يمكنني أن أفعل بهذا المورد؟". سيجيب الخادم باستجابة HTTP تحتوي على معلومات حول الخيارات المتاحة لذلك المورد. عادةً ما يتم توفير المعلومات في شكل رؤوس HTTP، مثل Allow، وAccept، وContent-Type، إلخ.

عند إجراء متصفح ويب لطلب عبر-origin، سيقوم أولاً بإرسال طلب تمهيدي باستخدام طريقة HTTP OPTIONS إلى الخادم. يُستخدم الطلب التمهيدي للتحقق مما إذا كان الخادم يسمح بإجراء الطلب الفعلي. سيجيب الخادم باستجابة HTTP تحتوي على رؤوس متعلقة بـ CORS، مثل Access-Control-Allow-Origin، وAccess-Control-Allow-Methods، وAccess-Control-Allow-Headers، إلخ. إذا أشارت استجابة التمهيد إلى أن الطلب الفعلي مسموح به، فسيتابع المتصفح لإرسال الطلب الفعلي. خلاف ذلك، سيتوقف المتصفح عن الطلب ويبلغ عن خطأ.

كيف تستخدم طريقة HTTP OPTIONS

تستخدم طريقة HTTP OPTIONS لطلب معلومات حول خيارات الاتصال لعنوان URL أو خادم معين. يمكن استخدامها للتحقق مما إذا كانت الطرق مسموح بها، وما هي الرؤوس المدعومة، أو إذا كانت CORS مفعلة. لاستخدام طريقة HTTP OPTIONS، يمكنك إرسال طلب بكلمة OPTIONS متبوعة بعنوان URL أو علامة نجمة (*) للإشارة إلى الخادم بالكامل. على سبيل المثال:

OPTIONS /index.html HTTP/1.1
OPTIONS * HTTP/1.1

سيجيب الخادم برمز حالة ورأس Allow الذي يسرد الطرق المسموح بها. قد يتضمن أيضًا رؤوسًا أخرى مثل Access-Control-Allow-Origin، وAccess-Control-Allow-Methods، وAccess-Control-Allow-Headers، وAccess-Control-Max-Age لأغراض CORS. على سبيل المثال:

HTTP/1.1 200 OK
Allow: GET, HEAD, POST, OPTIONS
Access-Control-Allow-Origin: https://foo.example
Access-Control-Allow-Methods: POST, GET, OPTIONS
Access-Control-Allow-Headers: X-PINGOTHER, Content-Type
Access-Control-Max-Age: 86400

يمكنك استخدام أداة مثل Apidog لإرسال طلب OPTIONS ورؤية رؤوس الرد.

كيف ترسل طلب HTTP OPTIONS باستخدام Apidog؟

الآن بعد أن أصبح لدينا فهم أساسي لما هي طريقة HTTP OPTIONS وماذا تفعل، دعنا نرى كيف يمكننا استخدامها لاستكشاف أي واجهة برمجة التطبيقات. لهذا الغرض، سنستخدم Apidog، وهي أداة على الويب تتيح لك التفاعل مع أي واجهة برمجة تطبيقات بطريقة بسيطة وبديهية. يمكنك استخدام Apidog لإرسال الطلبات، وعرض الردود، وفحص الرؤوس. يمكنك أيضًا استخدامها لتوليد مقتطفات من الشفرات، والوثائق، وحالات الاختبار لأي واجهة برمجة تطبيقات.

button

لإرسال طلب HTTP OPTIONS باستخدام Apidog، تحتاج إلى اتباع هذه الخطوات:

الخطوة 1: افتح Apidog وأنشئ طلبًا جديدًا.

الخطوة 2: اختر طريقة OPTIONS من قائمة طرق dropdown. سيخبر هذا Apidog بإرسال طلب HTTP OPTIONS إلى عنوان URL الذي أدخلته.

الخطوة 3: أدخل URI للمورد الذي تريد استكشافه في حقل إدخال URI وانقر على زر الإرسال أو اضغط على Ctrl+Enter. سيؤدي ذلك إلى إرسال الطلب إلى الخادم وعرض الرد في قسم الرد.

افحص رؤوس الرد وجسمه لرؤية المعلومات حول خيارات الاتصال المتاحة للمورد. يمكنك أيضًا استخدام حقل إدخال الفلتر للبحث عن رؤوس أو قيم محددة.

ما المعلومات التي يمكنك الحصول عليها من رد HTTP OPTIONS؟

عند إرسال طلب HTTP OPTIONS إلى مورد، يمكنك الحصول على الكثير من المعلومات حول خيارات الاتصال المتاحة لذلك المورد. عادةً ما يتم توفير المعلومات في شكل رؤوس HTTP، مثل Allow، وAccept، وContent-Type، إلخ. إليك بعض الرؤوس الشائعة وما تعنيه:

Allow: تتضمن هذه الرأس طرق HTTP المسموح بها للمورد. على سبيل المثال، إذا كانت الاستجابة تحتوي على Allow: GET، وPOST، وHEAD، فهذا يعني أنه يمكنك استخدام طرق GET، أو POST، أو HEAD للتفاعل مع المورد.
Accept: تتضمن هذه الرأس أنواع الوسائط المقبولة للمورد. على سبيل المثال، إذا كانت الاستجابة تحتوي على Accept: application/json، وapplication/xml، فهذا يعني أنك يمكنك طلب المورد سواء بتنسيق JSON أو XML.
Content-Type: تشير هذه الرأس إلى نوع الوسائط لجسم الرد. على سبيل المثال، إذا كانت الاستجابة تحتوي على Content-Type: application/json، فهذا يعني أن جسم الرد بتنسيق JSON.
Access-Control-Allow-Origin: تشير هذه الرأس إلى المصادر التي يمكنها الوصول إلى المورد. على سبيل المثال، إذا كانت الاستجابة تحتوي على Access-Control-Allow-Origin: *، فهذا يعني أن أي مصدر يمكنه الوصول إلى المورد. إذا كانت الاستجابة تحتوي على Access-Control-Allow-Origin: https://example.com، فهذا يعني أن المصدر https://example.com فقط يمكنه الوصول إلى المورد.
Access-Control-Allow-Methods: تشير هذه الرأس إلى الطرق المسموح بها للمورد. على سبيل المثال، إذا كانت الاستجابة تحتوي على Access-Control-Allow-Methods: GET، وPOST، وOPTIONS، فهذا يعني أنك يمكنك استخدام طرق GET، وPOST، أو OPTIONS للوصول إلى المورد.
Access-Control-Allow-Headers: تشير هذه الرأس إلى الرؤوس المسموح بها للمورد. على سبيل المثال، إذا كانت الاستجابة تحتوي على Access-Control-Allow-Headers: Content-Type، وAuthorization، فهذا يعني أنه يمكنك استخدام رؤوس Content-Type أو Authorization للوصول إلى المورد.
Access-Control-Max-Age: تشير هذه الرأس إلى مدة الوقت التي يمكن لمتصفح الويب تخزين استجابة التمهيد. على سبيل المثال، إذا كانت الاستجابة تحتوي على Access-Control-Max-Age: 86400، فهذا يعني أن المتصفح يمكنه تخزين استجابة التمهيد لمدة 86400 ثانية (24 ساعة).

هذه بعض الرؤوس الشائعة التي يمكنك الحصول عليها من رد HTTP OPTIONS. قد تكون هناك رؤوس أخرى خاصة بواجهة برمجة التطبيقات أو المورد الذي تستكشفه. يمكنك استخدام Apidog لفحص جميع الرؤوس وقيمها، والتعرف عليها بشكل أكبر.

خاتمة

في هذه المقالة، لقد عرضت لك كيفية استخدام طريقة HTTP OPTIONS لاستكشاف أي واجهة برمجة التطبيقات. طريقة HTTP OPTIONS هي أداة قوية ومفيدة يمكن أن تساعدك على اكتشاف قدرات وميزات أي واجهة برمجة التطبيقات. من خلال استخدام طريقة HTTP OPTIONS، يمكنك توفير الوقت والمتاعب عند العمل مع واجهات برمجة التطبيقات. يمكنك أيضًا تعلم أشياء جديدة وتحسين طلباتك.

لقد عرضت لك أيضًا كيفية استخدام Apidog، وهي أداة على الويب تتيح لك التفاعل مع أي واجهة برمجة تطبيقات بطريقة بسيطة وبديهية.

button