الطلبات

أنشئ طلبات HTTP وأرسلها، واختر وضع الجسم، واقرأ الاستجابة، وولّد شيفرة لتطبيق الويب.

شاهد هذا في الشرح: العمل اليومي مع واجهات API (2:43)

الطلب هو استدعاء API محفوظ. تبنيه في محرر الطلبات، وترسله بالزر Send، وتقرأ النتيجة في لوحة الاستجابة. يُحفظ كل طلب كملف YAML مستقل داخل مساحة العمل، فيظهر أي تغيير في استدعاء واحد كفرق صغير في Git.

بناء طلب

يقع شريط URL في أعلى محرر الطلبات. وهو يحتوي على الطريقة والعنوان والبروتوكول.

  1. اختر طريقة من قائمة الطرق، ثم اكتب العنوان في شريط URL.
  2. استخدم متغيرات مثل {{base_url}} للمضيف. يحلّها Getman من البيئة النشطة عند الإرسال.
  3. أضف معاملات المسار بنقطتين، مثل /orders/:id. ينشئ Getman صفا لكل معامل تحت Params، فيمكنك ملء قيمة لكل طلب.
  4. افتح الألسنة الأخرى عند الحاجة:
اللسان يحتوي على
Params معاملات الاستعلام ومعاملات المسار
Headers ترويسات الطلب
Auth المصادقة لهذا الطلب، أو Inherit
Body جسم الطلب
Scripts سكربتات ما قبل الإرسال وما بعد الاستجابة
Tests تأكيدات بلا شيفرة ومستخرجات
Settings خيارات الطلب، مثل Send cookies from jar

يُظهر اللسان الذي فيه محتوى عددا أو نقطة، فترى ما تم ضبطه دون فتحه.

البروتوكولات

تحتوي قائمة البروتوكول في شريط URL على HTTP، وتحتوي المجموعة Other protocols على GraphQL وWebSocket وServer-Sent Events. يستخدم طلب GraphQL لسان Query بدلا من Body. تستقبل طلبات WebSocket إطارات نصية وثنائية، وترسل نصا فقط. تستخدم Server-Sent Events خط المعالجة نفسه الذي يستخدمه HTTP.

أوضاع الجسم

يقدم لسان Body هذه الأوضاع:

الوضع استخدمه لـ
None طلبات GET وأي شيء بلا جسم
JSON حمولات application/json
Text نص عادي
XML مستندات XML
Form حقول application/x-www-form-urlencoded
Multipart multipart/form-data مع أجزاء نصية وملفات
File ملف ثنائي واحد

لا تُصدَّر مسارات الملفات في أجسام Multipart وFile إلى عقد OpenAPI أبدا.

الإرسال وقراءة الاستجابة

  1. اضغط Send، أو ⌘↵ على macOS وCtrl+Enter على غيرها.
  2. اقرأ الحالة والترويسات والمحتوى في لوحة الاستجابة.
  3. اضغط ⌘. لإلغاء طلب ما زال يعمل.
  4. اضغط ⌘S لحفظ الطلب.

الاستجابات الفاشلة من نوع 4xx و5xx

تفشل استجابة 4xx أو 5xx الطلب في التطبيق والمشغّل وسطر الأوامر والوكلاء. يُضاف إلى النتيجة الفحص Status is not an HTTP error. قبل هذا التغيير، كان سطر الأوامر يعتبر استجابة 500 بلا اختبارات ناجحة.

إذا كانت الحالة هي المتوقعة، فأضف تأكيد حالة لها. مثلا، ينبغي أن يحتوي طلب يتحقق من حالة عدم التفويض على Status is 401. يجتاز الطلب عندما يتطابق التأكيد.

توليد الشيفرة

استخدم ⋯ ← Generate code… لإنشاء مقطع بصيغة Fetch أو Axios لتطبيق الويب. ينسخ Copy as cURL الطلب إلى الحافظة كأمر shell، واختصاره ⌘⇧C. لا تُصدَّر بيانات اعتماد OAuth 2.0 إلى المقاطع.

اختصارات لوحة المفاتيح

الإجراء macOS الأنظمة الأخرى
New request ⌘N Ctrl+N
Send ⌘↵ Ctrl+Enter
Save ⌘S Ctrl+S
التركيز على شريط URL ⌘L Ctrl+L
Copy as cURL ⌘⇧C Ctrl+Shift+C

راجع اختصارات لوحة المفاتيح للقائمة الكاملة.

الخطوات التالية

  • تشرح المصادقة كيف يحصل الطلب على بيانات الاعتماد.
  • يغطي الاختبار التأكيدات والمستخرجات والسكربتات.