كيفية إرسال طلب إلى REST Web API
نوع الطلب
يدعم اختبار REST Web API طرق HTTP المختلفة التي يمكن استخدامها وفقا لأهداف الاختبار الخاصة بك. سيؤدي تحديد طلب GET ببساطة إلى استرداد البيانات من واجهة برمجة تطبيقات الويب الخاصة بك. على الرغم من أنه يمكن تضمين معلمات الطلب في عنوان URL ، فمن المستحسن استخدام طرق مخصصة لدفع الحمولة إلى واجهة برمجة التطبيقات.
لإرسال أي معلومات مخصصة أو تغيير البيانات أو تشغيل أي تدفق أو حدث، استخدم أنواع الطلبات مثل POST أو PUT أو PATCH. في هذه الحالة، لتحديد نص الطلب، انتقل إلى قسم نشر البيانات .
إذا قمت بتعيين نوع الطلب إلى POST أو PUT أو PATCH، ولكنك لم تحدد معلمات الطلب في قسم نشر البيانات ، تغيير نوع الطلب مرة أخرى إلى GET عند حفظ المهمة.
المصادقه
إذا كانت واجهة برمجة التطبيقات تتطلب المصادقة، فقم بتوفير بيانات الاعتماد في قسم المصادقة الأساسية . إذا كانت المصادقة المستندة إلى الرمز المميز هي الطريقة المستخدمة، فاتبع التوصيات المقدمة لواجهات برمجة التطبيقات المستندة إلى OAuth 2.0 وقم بتكوين معلمات المصادقة بطريقة مماثلة.
نشر البيانات
في هذا القسم، يمكنك بسهولة توفير أي كيانات طلب، مثل JSON.
لتحديد نص الطلب، ما عليك سوى لصق محتوى JSON أو إدخاله في الحقل. سيقوم النظام تلقائيا بتحليل الرمز وسيطلب منك تحديد رأس نوع المحتوى بناء على نوع نص الطلب. يمكنك أيضا توفير رأس مخصص من نوع المحتوى إذا لزم الأمر.
بمجرد تحديده، ستتم إضافة نوع المحتوى تلقائيا إلى قسم الرؤوس .
إنشاء مجموعة من الطلبات
يمكنك إرسال أي عدد تريده من الطلبات داخل الاختبار. لاحظ أنه يجب إضافة جميع الطلبات إلى الاختبار بالترتيب الذي يجب تنفيذها به.
لإعداد اختبار متعدد الطلبات:
- أولا، قم بإنشاء اختبار Rest Web API جديد وحفظه.
- لإعداد سلسلة من الطلبات داخل الاختبار، في قائمة الاختبارات، من قائمة
إجراءات الاختبار، حدد إضافة هدف. - قم بإعداد إعدادات الطلب واحفظ التغييرات. سيتم سرد الطلبات على الشريط الجانبي على شاشة تحرير الجهاز بالترتيب الذي سيتم تنفيذه. للوصول إلى معلمات الطلب، حدد العنصر المقابل على الشريط الجانبي.
- لإضافة الطلب التالي من داخل واجهة تحرير الجهاز ، انقر فوق الزر “زائد” على الشريط الجانبي.
لمعرفة المزيد من المعلومات حول تكوين الأجهزة متعددة الأهداف ومراقبتها، راجع إضافة عدة أهداف داخل جهاز واحد.
التحقق من صحة النتائج
بشكل عام ، لا يكفي إجراء مكالمة إلى واجهة برمجة تطبيقات ، والغرض من ذلك هو التأكد من أن استجابة واجهة برمجة التطبيقات تحتوي على بيانات كان من المتوقع تلقيها. للتحقق من استجابة واجهة برمجة التطبيقات ، يكفي العثور على بعض الكلمات الرئيسية التي تتطابق تماما مع الاستجابة. معرفة محتوى استجابة واجهة برمجة التطبيقات، يمكنك توفير الكلمات الرئيسية في قسم التحقق من صحة المحتوى . لمعرفة التفاصيل، يرجى الاطلاع على مقالة الكلمة الرئيسية .
حالات الاستخدام
دعونا ننظر في واجهة برمجة تطبيقات REST للبريد الإلكتروني كمثال. لمراقبة الخدمة ، نحتاج إلى إرسال طلب POST إلى نقطة نهاية واجهة برمجة التطبيقات المقابلة ، إلى جانب تفاصيل البريد الإلكتروني في نص الطلب. للقيام بذلك ، يتعين علينا توفير عنوان URL لنقطة النهاية وتحديد نوع طلب POST .
نظرا لأن واجهة برمجة تطبيقات REST للبريد الإلكتروني تتطلب مصادقة أساسية ، فنحن بحاجة أيضا إلى توفير بيانات الاعتماد في القسم المقابل.
في قسم نشر البيانات ، سنحدد صفيف JSON مع تفاصيل البريد الإلكتروني ونختار نوع الرأس لدفع الحمولة إلى نقطة نهاية واجهة برمجة التطبيقات.
الخطوة التالية هي تحديد كلمة رئيسية للبحث عنها في استجابة واجهة برمجة التطبيقات للتحقق من صحتها.
-
مراقبة واجهة برمجة تطبيقات REST
تستخدم غالبية تطبيقات الويب الحديثة واجهة برمجة تطبيقات REST للتواصل مع الخادم والتكامل مع بعضها البعض. لضمان الجودة المناسبة للبيانات في واجهة برمجة التطبيقات ، نضمن جودة خدمة الويب بأكملها التي تستخدمها.
لنفترض أنك قمت بإنشاء واجهة برمجة تطبيقات RESTful لخدمة الويب الخاصة بك ، ومن الضروري التحكم في أن جميع وظائف واجهة برمجة التطبيقات تعمل بشكل صحيح ومتاحة 24 / 7. ولكن لماذا نحتاج إلى اختبار واجهة برمجة تطبيقات WEB ، أليس من الأسهل اختبار واجهة مستخدم بحثا عن المشكلات؟ دعونا نناقش المزايا الأكثر شيوعا لاختبار واجهة برمجة التطبيقات ومراقبتها.
الميزة الأولى لاختبار واجهة برمجة تطبيقات REST هي أنه يساعد على تحديد مصدر معين للمشكلة. من خلال اختبار واجهة برمجة التطبيقات الخاصة بك ، يمكنك العثور على الوظيفة المحددة التي يتم تنفيذها باستخدام الأخطاء.
أيضا ، مع اختبار API ، لا تحتاج إلى إنشاء بيئة اختبار مخصصة لاختبار وظائف خدمة الويب الخاصة بك. على عكس اختبارات واجهة المستخدم التي تتطلب سلسلة من إجراءات المستخدم في نافذة المتصفح لإرسال طلب إلى خادم ويب ، يمكن إجراء اختبار واجهة برمجة التطبيقات ومراقبتها باستخدام أدوات تلقائية لإرسال طلب نقطة نهاية محدد. على سبيل المثال، يسمح لك هذا النهج بتجاوز هذه المشكلة حيث تحدث حالات فشل اختبار خاطئة على مستوى واجهة المستخدم الرسومية.
على الرغم من أنه يمكنك اختبار جميع وظائف واجهة برمجة التطبيقات يدويا ، إلا أنها عملية صعبة وتستغرق وقتا طويلا. علاوة على ذلك ، في كل مرة تقوم فيها بإجراء تغييرات أو إضافة ميزات جديدة إلى واجهة برمجة التطبيقات الخاصة بك ، يجب تنفيذ الاختبارات مرة أخرى للتأكد من أن التحديثات لم تؤثر على وظائف واجهة برمجة التطبيقات. تسمح مراقبة واجهة برمجة تطبيقات REST التلقائية بتجنب عيوب الاختبار اليدوي ويمكن أن تجلب روتين مراقبة واجهة برمجة التطبيقات الخاص بك إلى المستوى التالي.
مراقبة واجهة برمجة تطبيقات REST باستخدام Dotcom-Monitor
يوفر Dotcom-Monitor خيارين لمراقبة أداء واجهة برمجة التطبيقات تلقائيا:
- جهاز مراقبة واجهة برمجة تطبيقات ويب REST.
- جهاز مراقبة مجموعة ساعي البريد.
لإعداد اختبار مراقبة واجهة برمجة التطبيقات RESTful من الصفر ، يوصى باستخدام جهاز مراقبة واجهة برمجة تطبيقات الويب REST الخاص بنا. يسمح لك هذا النوع من أجهزة المراقبة بتكوين طلب HTTP بسيط إلى نقطة نهاية API باستخدام مصادقة أساسية ومعلمات POST.
في حال كنت قد استخدمت Postman بالفعل لتشغيل اختبارات خدمات RESTful API الخاصة بك ، فمن المستحسن استيراد مجموعة Postman الخاصة بك إلى Dotcom-Monitor. بمجرد استيراد مجموعة طلبات ساعي البريد إلى النظام ، يمكنك تكوين جهاز مراقبة مجموعة ساعي البريد لأتمتة مراقبة خدمات واجهة برمجة التطبيقات الخاصة بك.
على الرغم من أن جهاز REST Web API يدعم تنفيذ الطلبات المتعددة ، إلا أنه في بعض الحالات قد يكون من الصعب تكوينه. في المقابل ، إذا كنت على دراية بالأداة ، فإن Postman رائع لتكوين طلبات HTTP المعلمة واختبارات التأكيد لمراقبة REST Web API.
وبالتالي ، إذا كنت ترغب في إنشاء اختبار مع تسلسل معقد من مكالمات واجهة برمجة التطبيقات أو عندما تكون هناك حاجة إلى مصادقة أخرى غير المصادقة الأساسية ، فاستخدم Postman لإنشاء مجموعة من استدعاءات واجهة برمجة التطبيقات. بعد ذلك ، ما عليك سوى استيراده إلى جهاز Dotcom-Monitor Postman Collection وإعداد المراقبة كما هو موضح في مراقبة ساعي البريد (مهام التجميع) باستخدام واجهات برمجة تطبيقات Dotcom-Monitor. سيقوم Dotcom-Monitor بتنفيذ مكالمات واجهة برمجة التطبيقات بتردد محدد (يصل إلى 1 دقيقة) ، وإنشاء تقارير ، وإرسال إشعارات خطأ المراقبة إلى عنوان مقدم.
تأكد من التحقق من مجموعتنا الكاملة من أدوات مراقبة واجهة برمجة التطبيقات في Dotcom-Monitor للمساعدة في ضمان موثوقية تطبيقات وخدمات الويب!