متى تختار بارامترات المسار مقابل بارامترات الاستعلام؟

المتغيرات هي رؤية شائعة عند التعامل مع واجهات برمجة التطبيقات أو خدمات الويب. قد لا تدرك حتى أنك كنت تستخدم المتغيرات طوال هذا الوقت! أحد الأماكن الشائعة التي تتفاعل فيها مع المتغيرات هي عناوين الويب. ومع ذلك، هل تعلم أن هناك أنواعًا مختلفة من المتغيرات؟

💡

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

يمكن أن تكون Apidog خيارًا جيدًا للبدء إذا كنت مهتمًا بالمتغيرات. مع واجهة مستخدم بسيطة وبديهية، يمكنك البدء بسرعة من خلال النقر على الزر أدناه! 👇 👇 👇

زر

ستقدم هذه المقالة أساسيات المتغيرات، تليها مناقشة حول ما هي متغيرات المسار والاستعلام. سيكون هناك أيضًا قسم حول أنواع السيناريوهات التي تفضل استخدام متغيرات المسار بدلاً من المتغيرات الاستعلام، والعكس صحيح.

الأساسيات أولاً: المتغيرات في واجهات برمجة التطبيقات

في واجهات برمجة التطبيقات، المتغيرات هي عناصر متغيرة يمكن أن تؤثر مباشرة على وظيفة طلب واجهة برمجة التطبيقات. تقدم المتغيرات معلومات أو تعليمات محددة لواجهات برمجة التطبيقات، مما يجعلها مسؤولة عن ما ستقوم به واجهة برمجة التطبيقات في استجابتها.

وظائف المتغيرات

لتسهيل الأمور، إليك ثلاث نقاط للوظائف التي يمكن أن توفرها المتغيرات لمطوري واجهة برمجة التطبيقات:

تحديد الطلبات: يمكن للمتغيرات تحديد نوع الإجراء الذي ترغب في أن تقوم به واجهة برمجة التطبيقات على مورد معين.
تخصيص الاستجابات: تؤثر المتغيرات على محتوى أو تنسيق واجهة برمجة التطبيقات المقدم استجابةً لطلبك.
تصفية البيانات: تستخدم المتغيرات لتصفية النتائج المستلمة من واجهة برمجة التطبيقات.

طرق مختلفة لتنفيذ المتغيرات

هناك بعض الطرق لـ تمرير المتغيرات في طلبات واجهة برمجة التطبيقات. لاحظ أن هذه هي النقطة التي تظهر فيها مصطلحات متغيرات المسار والاستعلام.

مسار URL: هذه هي متغيرات مدمجة مباشرة في مسار URL، مثل /users/{id} حيث {id} هو متغير يمثل معرف مستخدم معين.

يمكن الإشارة إلى معلمة {id} هنا على أنها معلمة مسار.
سلسلة الاستعلام: سلسلة الاستعلام هي أزواج من القيم والمفاتيح الملحقة بـ URL بعد علامة استفهام (?)، مثل ?limit=10&sort=name حيث limit و sort هما متغيرات ذات قيم مت Corresponding.

تسمى أزواج القيم والمفاتيح مثل limit و sort أيضًا متغيرات الاستعلام.
الرؤوس: هذه هي معلومات إضافية تُرسل مع الطلب، مثل رمز التفويض الخاص بك أو اللغة المفضلة.
جسم الطلب: يمكن إرسال بيانات معقدة لإنشاء أو تعديل الموارد في جسم الطلب، غالبًا بتنسيقات مثل JSON أو XML.

ما هي متغيرات المسار؟

متغيرات المسار هي عناصر embedded مباشرة داخل مسار URL لطلب واجهة برمجة التطبيقات وتعمل كعنصر نائب للقيم المحددة. تُستخدم لتوجيه وتحديد الموارد الفريدة داخل واجهة برمجة التطبيقات.

أمثلة على متغيرات المسار

/users/{id} هو مثال على متغير مسار. إنه يمثل متغير مسار لمستخدم معين (المستخدم هو مورد في هذه العينة).

إذا رأيت هذه الأقواس المعكوفة {} في URL، فهي متغير مسار. ومع ذلك، في الممارسة العملية، لن ترى أقواس معكوفة على المواقع لأنها تُستبدل بالقيم المحددة لعملية واجهة برمجة التطبيقات.

لماذا تستخدم متغيرات المسار؟

تُختار متغيرات المسار بشكل أساسي لتحديد بيانات أو كيان معين، مثل مستخدم أو منتج، استنادًا إلى معرفه الفريد (ID).

تعد متغيرات المسار أيضًا وسيلة ممتازة لزيادة قابلية قراءة عنوان URL. فهي تسمح لعناوين URL بأن تكون أكثر وصفًا وذات توثيق ذاتي، مما يعني أن المطورين الآخرين يمكنهم فهم عنوان URL بالإضافة إلى فهم ما يُفترض أن يفعله.

أخيرًا، يمكن أن تكون متغيرات المسار متداخلة لتمثيل هيكل هرمي داخل نموذج موارد واجهة برمجة التطبيقات، لذا يمكنك الوصول إلى الموارد داخل المجموعات المتداخلة. يمكنك التفكير في الأمر كأنك تدخل مجلدات داخل مجلدات للحصول على الوصول إلى ملف واحد.

ما هي متغيرات الاستعلام؟

تُعرف متغيرات الاستعلام بأسماء أخرى - متغيرات URL أو سلاسل الاستعلام. إنها معلومات إضافية ملحقة بـ URL بعد علامة استفهام ?.

تأتي متغيرات الاستعلام في أزواج من القيم والمفاتيح، مفصولة بعلامة & &. يُشار إلى متغيرات الاستعلام على أنها تعليمات اختيارية مصممة لتعديل سلوك طلب واجهة برمجة التطبيقات دون تغيير المورد الأساسي.

أمثلة على متغيرات الاستعلام

/users?sort=name&limit=10 هو مثال URL يتكون من متغيرين للاستعلام، sort و limit.

أزواج القيم والمفاتيح الموجودة في هذا المثال هي sort=name و limit=10.

لماذا تستخدم متغيرات الاستعلام؟

بالمقارنة مع متغيرات المسار، تُستخدم متغيرات الاستعلام أكثر لوظيفتها.

يمكن لمتغيرات الاستعلام تعديل سلوك طلب واجهة برمجة التطبيقات من خلال إضافة مزيد من المعلومات، مثل في عمليات:

التصفية: تصفية النتائج بناءً على معايير محددة (مثل، ?category=electronics).
الترتيب: ترتيب النتائج بناءً على معايير محددة (مثل، ?sort=price,desc).
الصفحات: استرجاع النتائج في أجزاء أصغر لتحسين الأداء (مثل، ?page=2&per_page=20).
البحث: البحث عن موارد معينة بناءً على الكلمات الرئيسية (مثل، ?q=books).

متغيرات المسار مقابل متغيرات الاستعلام - مُدَرج

الميزة	متغير path	متغير query
الموقع	مضمن في مسار URL (`{id}`)	مضاف بعد '?' (`?sort=name&limit=10`)
الغرض	تحديد الموارد المحددة	تعديل سلوك الطلب (تصفية، ترتيب، إلخ)
الزامي	نعم	لا
الأمان	أقل أمانًا (مرئي في URL)	أكثر أمانًا قليلًا (مفصول عن مسار URL)
قابلية القراءة	تحسين قابلية القراءة	قد تقلل من قابلية القراءة
التسلسل الهرمي	يمكن أن يكون متداخلاً	غير مناسب للتسلسل الهرمي

أداة تطوير API كاملة وقوية لعام 2024 - Apidog

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

api design first development platform — Apidog - منصة تطوير ذات تصميم API أولاً

زر

تعد Apidog منصة ممتازة لأولئك الذين يقدّرون واجهة مستخدم بسيطة ولكن بديهية. إذا كنت تخطط للتعرف على متغيرات المسار والاستعلام. في هذه الحالة، يمكن لـ Apidog أن تظهر لك بوضوح كيفية استيراد REST API أو SOAP API والسماح لك بتعديلها.

استيراد ملفات API الخاصة بك إلى Apidog

لمشاهدة كيفية تضمين المتغيرات في عناوين URL الخاصة بـ API، ستحتاج إلى استيراد واجهة برمجة التطبيقات إلى Apidog.

import api apidog file — Apidog يدعم العديد من أنواع ملفات API!

اختر نوع الملف المناسب الموافق لملف API الخاص بك. إذا لم تتمكن من العثور على نوع الملف الدقيق، قم بسحب الملف إلى الجزء السفلي من النافذة، كما هو موضح في الصورة أعلاه.

اختبار نقاط النهاية (أو عناوين URL) لواجهة برمجة التطبيقات باستخدام Apidog

بمجرد أن تقوم باستيراد واجهة برمجة التطبيقات بنجاح، يمكن اختبارها من خلال إرسال طلب باستخدام Apidog.

select test soap api request apidog — تحديد واختبار طلب SOAP API واحد

اختر إحدى طلبات واجهة برمجة التطبيقات الخاصة بك المتاحة على الجانب الأيمن من الشاشة، كما هو موضح من السهم 1.

ثم، يمكنك إرسال الطلب بالنقر على الزر المشار إليه بسهم 2، ولكن تأكد من أنك قد اخترت البيئة الصحيحة أو أدرجت عنوان URL الصحيح لطلب واجهة برمجة التطبيقات.

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

إضافة متغيرات إلى عنوان URL لواجهة برمجة التطبيقات على Apidog

soap api add parameter edit url apidog — إضافة متغيرات إضافية وتعديل عنوان URL على Apidog

يمكنك إضافة متغيراتك الخاصة إلى عنوان URL لواجهة برمجة التطبيقات من خلال النقر على رأس Params كما هو موضح في الصورة. كن حذرًا، إذا كنت ستضيف متغيرًا، تأكد من الالتزام بالهيكل الصحيح (مثل الأقواس المعكوفة {} للمتغيرات المسار والرموز المحددة &, ? و = لمتغيرات الاستعلام).

الخاتمة

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

Apidog هي منصة تطوير واجهة برمجة التطبيقات الشاملة التي يمكنها استيراد أنواع مختلفة من ملف API. إنها أداة واجهات برمجة التطبيقات المتميزة التي توفر العديد من الخدمات الضرورية المتعلقة بتطوير واجهات برمجة التطبيقات. مع الوظائف التي تسمح للمستخدمين ببناء وتوثيق ومحاكاة واختبار واجهات برمجة التطبيقات، فهي بالتأكيد أداة قوية بجانب Postman وSwaggerHub.