طلب أول API في الاختصارات على Mac
لطلب أول API لك، يمكنك إنشاء رابط الذي يشير إلى "نقطة نهاية" API التي تريد الاتصال بها، ثم تمرير هذا الرابط إلى إجراء "إحضار محتويات الرابط". عند تشغيل الاختصار، يُصدِر هذا الإجراء طلب API.
إنشاء طلب API
تتطلب نقطة نهاية Typicode أن يتم تنسيق طلب رابط بهذه الطريقة:
https://jsonplaceholder.typicode.com/[RESOURCE]
النص بين القوسين يمثل المصدر الذي ترغب في الوصول إليه. يوفر Typicode العديد من الأمثلة المختلفة لطلبات الاختبار. سيستخدم هذا المثال https://jsonplaceholder.typicode.com/users لطلب قائمة بالمستخدمين.
في تطبيق الاختصارات
على Mac، أضِف الطلب إلى الرابط.سيعمل الطلب
usersعلى إنتاج قائمة بالمستخدمين.يمكنك تضييق نطاق البحث عن طريق تحديد مستخدم معين بواسطة المعرف:
https://jsonplaceholder.typicode.com/users/6. سيؤدي ذلك إلى إرجاع المستخدم صاحب المعرف ٦.تسمح معظم واجهات API بالاستعلامات باستخدام التنسيق التالي:
https://jsonplaceholder.typicode.com/users?username=Bret. العلامة "؟" تبدأ الاستعلام، الذي يبحث عن العناصر باستخدام أزواج المفتاح/القيمة. في هذا المثال، يبحث الاستعلام?username=Bretعن مستخدم باسم المستخدم Bret.تحقق من وثائق API لديك لمعرفة عمليات البحث والاستعلامات المدعومة.
تنفيذ طلب API باستخدام إجراء إحضار محتويات الرابط
في تطبيق الاختصارات
على Mac، انقر على إظهار المزيد في إجراء إحضار محتويات الرابط.عندئذٍ تتوفر الخيارات التالية لأنواع طلبات API التي يمكنك إصدارها:
GET، وهو يتيح لك جلب البيانات.
POST، وهو يسمح لك بإنشاء بيانات جديدة.
PUT، وهو يتيح لك تحديث البيانات من خلال استبدالها.
PATCH، وهو يتيح لك تحديث البيانات من خلال تعديلها.
DELETE، وهو يسمح لك بإزالة أي كائن محدد في طلب الرابط.
في هذا المثال، يمكنك استخدام طلب
GETلجلب البيانات من واجهة API لـ Typicode.الآن بعد أن حصل "الرابط" على طلبك وتم إعداد إجراء "إحضار محتويات الرابط"
GETالبيانات، أنت جاهز لتنفيذ طلب API.ملاحظة: عند تبديل إجراء "إحضار محتويات الرابط" إلى
POSTأوPUTأوPATCH، تتم إضافة معامل جديد اسمه طلب النص. يسمح لك "طلب النص" بإرسال JSON أو نموذج أو ملف إلى API كجزء من الطلب. ويتيح لك ذلك إمكانية إدخال البيانات الجديدة يدويًا أو باستخدام متغيرات حتى يمكنك إرسال البيانات إلى API لإنشاء إدخال أو استبداله أو تعديله.لاختبار الاختصار، انقر على
.
تبدو واجهة API، من الوهلة الأولى، كأنها تُرجع الكثير من النص. يتم ترميز هذه البيانات بترميز JSON، وهو اختصار لمصطلح JavaScript Object Notation.
لمعرفة معلومات حول استخدام JSON وللمتابعة مع مثال واجهة API لـ Typicode، انظر مقدمة عن استخدام JSON في الاختصارات على Mac.