دليل: كيفية تمرير المعرفات في عناوين URL لواجهة برمجة تطبيقات REST

عناوين REST API مرنة وقابلة للتوسيع، مما يعني أنها يمكن أن تخدم العديد من الأغراض المتعلقة بذلك. أحد المكونات الشائعة التي قد تجد نفسك تستخدمها كثيرًا هي المعرفات - لكن هل تعرف كيفية تمرير معلمات مثل قيمة المعرف في عناوين REST API؟

قبل أن نتDive deeper into كيفية تمرير المعرفات في عناوين REST API، دعنا نراجع ما هي REST APIs.

ما هي REST APIs؟

REST APIs (واجهات برمجة التطبيقات لنقل حالة التمثيل) هي أدوات لتطبيقات البرمجيات المختلفة لتكرار الرسائل أو البيانات. توفر طريقة موحدة للتواصل وتبادل البيانات بشكل آمن عبر الإنترنت.

لماذا تعتبر REST APIs مهمة جدًا؟

• ربط العالم الرقمي: تمكن REST APIs التطبيقات المختلفة من العمل معًا بسلاسة، مما يعزز ميزات مثل تسجيل الدخول عبر وسائل التواصل الاجتماعي، ودمج الخرائط، والمدفوعات عبر الإنترنت.
• تحفيز الابتكار: يمكن للمطورين بسهولة الوصول إلى الخدمات التي تقدمها شركات أخرى، مما يعزز التعاون والتطوير السريع.
• إنشاء المرونة وقابلية التوسع: تسهل REST APIs الأنظمة المودولارية، مما يتيح لك بناء وتحديث وتنمية تطبيقك دون الاعتماد على قاعدة كود أحادية.
• توحيد التطوير: اتباع مبادئ RESTful يضمن تفاعلات متوقعة، مما يجعل البرمجة والتكامل أكثر سلاسة للمطورين الآخرين.

المفاهيم الأساسية التي تحتاج لمعرفتها قبل تمرير المعرفات في عناوين REST API

هناك مفاهيم أساسية يجب معرفتها قبل أن تصبح محترفًا في تمرير المعرفات في عناوين REST API.

مبادئ تصميم RESTful

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

يتضمن التصميم RESTful أيضًا مبادئ تفاعل متسقة لتوحيد الطلبات المرسلة والاستجابات المستلمة.

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

هيكل URL

يمكن أن تحتوي عناوين REST API على عدد قليل من العناصر الرئيسية، والتي تشمل:

عنوان URL الأساسي: الجزء الثابت من عنوان URL الذي لا يتغير عند زيارة صفحات أخرى على الموقع.

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

المعرف: يُستخدم عندما ترغب في الوصول إلى مورد محدد داخل مجموعة.

سلسلة الاستعلام: تُستخدم لتصفية أو فرز أو تقسيم البيانات. تحتوي سلاسل الاستعلام على رموز ? و&.

معلمات المعرف

كما ذُكر أعلاه، تُستخدم معلمات المعرف لتمييز الموارد الفردية الموجودة داخل مجموعة

طرائق HTTP

هناك أربع طرق HTTP رئيسية قد تكون قد صادفتها، وهي:

GET: استرجاع بيانات المورد بواسطة معرف محدد.

POST: إنشاء مورد جديد داخل المجموعة. بالنسبة لطرائق POST، يمكنك تضمين معرف في جسم الطلب.

PUT: تحديث مورد موجود، عادة باستخدام المعرف في عنوان URL لتحديد المورد الذي يتم تحديثه.

DELETE: حذف مورد، مستهدف بناءً على معرفه.

كيفية تمرير المعرف في عناوين REST API

اعتمادًا على كيفية هيكلة مجموعاتك وتفضيلك الشخصي لكيفية صياغة عنوان REST API الخاص بك، هناك بعض الطرق الشائعة لتمرير المعرفات في عناوين REST API.

• استخدام معلمات المسار
  
  أولاً، معلمات المسار هي شغرات مضمنة في مسار عنوان URL، تُرى على أنها هذه الأقواس المعكوفة {}.
  
  تُخصص هذه الشغرات للمعرّفات الفريدة التي تشير إلى مورد محدد موجود ضمن مجموعتك.
  
  من خلال الشغرات، يمكنك تمرير المعرفات من خلال هيكل عنوان URL هذا:
  
  /users/{user_id}، حيث يتم استبدال {user_id} بالمعرفات الفعلية التي يمكن العثور عليها في مجموعتك.
  
• استخدام معلمات الاستعلام
  
  قد تحتاج أحيانًا إلى تمرير المعرفات في معلمات الاستعلام، خاصة في الحالات التي تحتاج فيها إلى تصفية أو فرز بياناتك وعرضها في قسم الواجهة الأمامية.
  
  مثال على كيفية تمرير معرف في معلمة الاستعلام سيكون:
  
  /users?name=John، حيث سيظهر أي معرف يحتوي على John. تعتبر هذه الطريقة لتمرير المعرف مفيدة خاصة عند الحاجة للعثور على سجل معين في مجموعة كبيرة جدًا.

أفضل الممارسات التي يجب معرفتها عند تمرير المعرفات في عناوين REST API

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

• الوضوح: استخدم أسماء معلمات واضحة ووصفية.
• الاتساق: حافظ على اتفاقية التسمية المتسقة عبر واجهة API الخاصة بك.
• الترميز: قم بترميز الأحرف الخاصة بشكل صحيح في عناوين URL لتجنب الأخطاء.
• الأمان: كن حذرًا بشأن البيانات الحساسة المعروضة في معلمات الاستعلام.

أداة تطوير API بسيطة وواضحة: Apidog

حافظ على بيئة تطوير API الخاصة بك وتعليمك نظيفة مع Apidog - منصة تطوير API ذات تصميم أولي شاملة مجانية للجميع لاستخدامها!

سيظهر القسم أدناه كيفية إجراء تعديلات واختبار على عناوين REST API الخاصة بك.

ولكن قبل أن تتمكن من تعديل عناوين REST API، دعنا نتعلم كيف نهيئ REST API بأنفسنا باستخدام Apidog.

تصميم APIs باستخدام Apidog

قبل كل مرحلة اختبار المنتج، هناك عملية تصميم. باستخدام Apidog، يمكنك تصميم APIs وفقًا لمواصفات OpenAPI، وإنشاء وثائق API المقابلة فقط بعدة نقرات.

تهيئة طرق REST API ونقاط النهاية

السهم 1 - أولاً، تأكد من أنك قمت بإنشاء عنوان URL جيد لطلبك. تأكد من عدم وجود أخطاء مطبعية أثناء الالتزام بأفضل الممارسات في صياغة عناوين REST API.

السهم 2 - قرر أي طريقة API تود استخدامها. الطرق الأكثر شيوعًا هي بشكل خاص GET وPOST وPUT وDELETE. في المثال أعلاه، تم اختيار طريقة GET.

السهم 3 - اشرح تفاصيل REST API بدقة من خلال تضمين معلمات الطلب، معلمات الاستجابة، والاستجابات النموذجية أدناه. يُوصى بشدة بأن يكون كل شيء ممتلئًا حيث سيتم تضمين كل متغير في وثائق API.

تحرير عناوين REST API باستخدام Apidog

إذا شعرت أن عنوان REST API غير متسق أو غير واضح جدًا، لديك خيار تعديله.

كل ما عليك فعله هو النقر على عنوان URL الخاص بـ HTTP كما هو موضح في الصورة أعلاه. تأكد من أنك تتذكر تطبيق معرفتك حول عناوين REST API الجيدة.

اختبار عناوين REST API باستخدام Apidog

بعد تعديل عنوان REST API الخاص بك، تحتاج إلى التأكد من أن عنوان REST API الخاص بك يعمل الآن.

أرسل الطلب لتلقي استجابة. قبل الضغط على زر Send، تأكد من أن نوع الطريقة وعنوان URL صحيحان.

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

استنتاج

تعلم كيفية تمرير المعرفات في عناوين REST API هي معرفة مهمة لمطوري الويب. إنها تسمح للمواقع الإلكترونية بعرض ما يرغب المستخدمون في رؤيته فقط. هناك مكانان رئيسيان حيث يمكن وضع المعرف داخل عنوان REST API، وهما معلمة المسار ومعلمة الاستعلام.

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

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