روابط REST API هي مكونات مهمة في خدمات الويب. بدونها، سيكون من الصعب على المواقع الإلكترونية تحديد الموارد داخل المجموعات. بشكل أساسي، تسمح للمواقع الإلكترونية بتغيير عروضها وفقًا لرغبات مستخدميها.
من خلال تسهيل الخدمات لدورة حياة API الكاملة، تعتبر أبيدوج اختيارًا مناسبًا لمنصة API لمطوري الويب الذين يبحثون عن حل شامل لعمليات تطوير API الخاصة بهم. دعونا نجرب أبيدوج اليوم! 👇
لفهم جيد لكيفية تمرير معلمات متعددة في رابط REST API، دعونا نفهم أولاً فرضية هذا السؤال.
ما هي المعلمة؟
المعلمات هي أجزاء من المعلومات تُدمج في رابط URL وتوفر تفاصيل إضافية تتعلق بمورد أو إجراء مطلوب. يمكن اعتبارها أيضًا طبقة إضافية من الفلترة لصفحات الويب.
أين تستخدم المعلمات؟
هناك العديد من المواقف الحياتية الواقعية حيث يتم تمرير المعلمات في روابط REST API. هذه بعض من السيناريوهات الرئيسية حيث يمكنك بسهولة رؤية المعلمات في العمل:
- REST APIs: تحدد المعلمات تباينات الموارد، وتصف البيانات، أو تتحكم في الإجراءات.
- محركات البحث: تستخدم المعلمات لتصفية استعلامات البحث أو تتبع الإحالات.
- مواقع التجارة الإلكترونية: لتصفية المنتجات، إدارة عربة التسوق، أو تتبع الحملات.
- منصات الوسائط الاجتماعية: لتخصيص المحتوى أو تفعيل إجراءات معينة.
أنواع المعلمات الشائعة لتمرير المعلمات في روابط REST API
عادةً، هناك نوعان من المعلمات التي يمكننا استخدامها لتمريرها في روابط REST API.
معلمات الاستعلام
معلمات الاستعلام هي نوع من المعلمات التي تُضاف بعد علامة الاستفهام ( ? ). عادةً، تأتي معلمات الاستعلام في زوج مفتاح-قيمة يتم فصله بواسطة علامة يساوي ( = )، ويتم ربط كل زوج مفتاح-قيمة معًا بواسطة رمز "و" ( & ).
رابط REST API حيث يمكنك ملاحظة تمرير معلمة استعلام هو:
https://api.example.com/users?id=123&name=جون%20تفاحة
أزواج معلمات المفتاح-القيمة التي يمكننا رؤيتها هي:
idبالقيمة123.nameبالقيمةجون تفاحة.
معلمات المسار
تعتبر معلمات المسار نوعًا آخر من معلمات URL التي يتم تمريرها عادةً في روابط REST API. تُستخدم هذه لتحديد والوصول إلى موارد محددة داخل ذلك النظام.
مظهر وبنية معلمات المسار مختلفة عن معلمات الاستعلام، ووظائفها أيضًا تختلف قليلاً. تُستخدم معلمات المسار بشكل أكبر لتحديد مورد معين داخل مجموعة.
مثال على معلمة مسار سيكون:
مع عنصر نائب: https://api.example.com/blog/posts/{post_id}
بدون عنصر نائب: https://api.example.com/blog/posts/123
كما يمكننا ملاحظة، تستخدم معلمة المسار بنية العنصر نائب (في هذا المثال هو {post_id})، حيث يتم استبدال القيمة الفعلية.
يمكنك حتى تجميع معلمات مسار متعددة لتحديد موارد أكثر تحديدًا في نظامك. مثال أكثر تعقيدًا لتمرير المعلمات في رابط REST API سيكون:
https://api.example.com/users/{user_id}/posts/{post_id}
طالما لديك قيم فعلية موجودة لاستبدال العناصر النائبة الموجودة على الرابط، يمكنك تغيير عرض موقعك على الويب. إذا كنت قد لاحظت، فإن استخدام معلمات المسار ينتج أيضًا روابط REST API أسهل في القراءة.
الخطوات الواجب اتخاذها لتمرير المعلمات في رابط REST API
خذ بعض الوقت للتفكير فيما يُستخدم من أجله رابط REST API، أو كيف تود صياغة رابط REST API الخاص بك، حيث تميل مواقع الويب المختلفة إلى احتياجات مختلفة، وبالتالي يمكنك أن تنتهي بتفضيل نوع واحد من المعلمات على الآخر.
إذا كنت تخطط لبناء موقع ويب أكثر ديناميكية، أو أن معلماتك اختيارية معظم الوقت، فيجب عليك أن تفكر في استخدام معلمات الاستعلام.
ومع ذلك، يجب عليك اختيار معلمات المسار إذا وجدت نفسك بحاجة باستمرار إلى معالجة هذه المعلمات للوصول إلى موارد معينة من نظامك.
علاوة على ذلك، يجب عليك التعرف على أفضل الممارسات لصياغة روابط REST API، حيث توجد بعض الإرشادات التي قد لا تعرفها أو لم تسمع بها من قبل.
أبيدوج - منصة تطوير REST API
أبيدوج هي منصة تطوير API تعتمد على التصميم أولاً مع واجهة مستخدم أنيقة ونظيفة. تتيح واجهتها الواضحة والمباشرة التنقل السهل وتعديل API أينما كان ذلك ضروريًا.
تستطيع أبيدوج أيضًا استيراد REST APIs، تعديل روابط REST API، واختبار الروابط. لمعرفة كيفية تشغيل أبيدوج لتعديل REST API الخاص بك، تابع القراءة في القسم أدناه.
تكوين روابط REST API، والطرق، ونقاط النهاية باستخدام أبيدوج
يمكنك بناء الواجهة البرمجية الخاصة بك باستخدام أبيدوج، بالإضافة إلى تطبيق ما تعلمته عن تمرير معلمات متعددة في روابط REST API!
السهم 1 - يمكنك البدء بصياغة رابط REST API لطلبك. تأكد من عدم وجود أخطاء إملائية بحيث يمكنك تلقي رد! يمكنك أيضًا تحديد عدد المعلمات، ونوع المعلمات التي ترغب في تضمينها.
السهم 2 - قرر ما هي طريقة REST API التي ترغب فيها. أكثر الطرق شيوعًا هي GET و POST و PUT و DELETE. ومع ذلك، لاحظ أن كل طريقة قد تتطلب معلمات ومعرفات في رابط URL.
السهم 3 - اشرح تفاصيل REST API بدقة من خلال تضمين معلمات الطلب، ومعلمات الردود، وأمثلة على الردود أدناه. يُوصى بشدة بملء كل شيء حيث سيتم تضمين كل متغير في وثائق API.
اختبار نقاط نهاية API (أو روابط API) باستخدام أبيدوج
بعد إنشاء REST API الخاص بك، يمكنك الاختبار لمعرفة ما إذا كان رابط REST API الذي قمت بإنشائه ناجحًا أم لا. يجب أن تكون قادرًا على رؤية شاشتك بشيء مشابه للصورة أدناه:
تدعم أبيدوج اختبار معظم أنواع نقاط نهاية API، بما في ذلك SOAP و GraphQL APIs. (في الصورة أعلاه، API المعروض هو SOAP API.)
أولاً، اختر طلبات REST API المتاحة على الجانب الأيمن من الشاشة، كما هو موضح في السهم 1.
ثم يمكنك إرسال الطلب بالنقر على الزر المشار إليه بالسهم 2، ولكن تأكد من أنك قد اخترت البيئة الصحيحة أو قد قمت بتضمين رابط API الصحيح.
أخيرًا، انتقل إلى قسم الاستجابة لرؤية الاستجابة التي تم تلقيها بعد إرسال الطلب، وتحقق مما إذا كانت هي نفس ما هو متوقع.
استنتاج
ستصبح تمرير معلمات متعددة في رابط REST API جزءًا شائعًا من عملية تطوير الويب الخاصة بك. مع نمو موقعك على الويب وقاعدة البيانات الخاصة بك، ستزداد أيضًا طول وتعقيد رابط REST API الخاص بك، لذلك لا يكون من المبكر أبدًا البدء في التع familiarizing مع هذا المفهوم.
إذا كنت بحاجة يومًا ما إلى منصة تطوير API لممارسة صياغة روابط REST API مع معلمات متعددة، يمكنك دائمًا التفكير في استخدام أبيدوج. تسهل أبيدوج أيضًا مجموعة متنوعة من التعديلات والمواصفات لدورة حياة API كاملة، لذا جربها الآن!