كيفية اختبار APIs باستخدام Postman و PHP

تمت الكتابة بواسطة: عبد الحكيم

تارخ آخر تحديث: 02 سبتمبر 2024

محتوى المقال

ما هو Postman؟
إعداد بيئة PHP لاختبار API
إرسال طلبات API باستخدام Postman
إضافة معلمات إلى طلبات Postman
تحليل الاستجابات واختبار صحة API
التكامل مع PHP Unit
الخلاصة

كيفية اختبار APIs باستخدام Postman و PHP

تعد واجهات برمجة التطبيقات (APIs) جزءًا أساسيًا من تطوير الويب، ومن الضروري التأكد من أنها تعمل بشكل صحيح قبل إطلاقها. Postman هو أداة قوية تتيح لك اختبار APIs بسهولة وتحليل الاستجابات بشكل فعال. في هذا المقال، سنتعرف على كيفية استخدام Postman لاختبار APIs تم تطويرها باستخدام PHP.

ما هو Postman؟

Postman هو تطبيق يتيح للمطورين إرسال طلبات HTTP إلى APIs وتحليل الاستجابات. يوفر واجهة مستخدم رسومية تساعد في اختبار وفحص واجهات برمجة التطبيقات بسهولة دون الحاجة إلى كتابة كود مخصص للاختبار.

إعداد بيئة PHP لاختبار API

قبل البدء في اختبار API باستخدام Postman، تأكد من إعداد بيئة تطوير PHP بشكل صحيح. قم بإنشاء API بسيط باستخدام PHP للاستجابة للطلبات، مثل المثال التالي:


        <?php

        // إعداد الرؤوس

        header('Content-Type: application/json');


        // التحقق من نوع الطلب

        if ($_SERVER['REQUEST_METHOD'] === 'GET') {

           // إرسال استجابة JSON

           $response = [

              'status' => 'success',

              'data' => 'Hello, world!'

           ];

           echo json_encode($response);

        } else {

           // إرسال استجابة خطأ

           $response = [

              'status' => 'error',

              'message' => 'Invalid request method.'

           ];

           echo json_encode($response);

        }

        ?>

هذا المثال بسيط جدًا ويستجيب لطلبات GET فقط. إذا تم إرسال طلب GET، ستستجيب API برسالة "Hello, world!"، وإذا كان الطلب من نوع آخر، ستعيد API رسالة خطأ.

إرسال طلبات API باستخدام Postman

الآن بعد إعداد API، يمكنك استخدام Postman لإرسال طلبات HTTP واختبار الاستجابات. اتبع الخطوات التالية:

افتح Postman.
حدد نوع الطلب (GET، POST، إلخ) من القائمة المنسدلة في الأعلى.
أدخل عنوان URL الخاص بالـ API (على سبيل المثال: http://localhost/simple_api.php).
انقر على زر "Send" لإرسال الطلب.

ستظهر الاستجابة من الخادم في القسم السفلي من Postman. يمكنك عرض الاستجابة في عدة صيغ (JSON، XML، نص، إلخ) وتحليلها.

إضافة معلمات إلى طلبات Postman

يمكنك إضافة معلمات إلى طلبات Postman لاختبار السيناريوهات المختلفة. على سبيل المثال، إذا كنت ترسل طلب GET إلى API يتطلب معلمات، يمكنك إضافتها إلى قسم "Params" في Postman. المعلمات سيتم إرسالها كجزء من عنوان URL.

تحليل الاستجابات واختبار صحة API

بعد إرسال الطلبات واستلام الاستجابات، يمكنك تحليل النتائج مباشرة داخل Postman. Postman يتيح لك أيضًا كتابة اختبارات للتحقق من صحة الاستجابات باستخدام JavaScript. على سبيل المثال، يمكنك التحقق مما إذا كان رمز الحالة هو 200 أو ما إذا كانت الاستجابة تحتوي على بيانات معينة.


        // التحقق من أن رمز الحالة هو 200

        pm.test("Status code is 200", function () {

           pm.response.to.have.status(200);

        });


        // التحقق من أن الاستجابة تحتوي على مفتاح 'status'

        pm.test("Response has status", function () {

           pm.expect(pm.response.json()).to.have.property('status');

        });

ستساعدك هذه الاختبارات على ضمان أن الـ API تستجيب بشكل صحيح تحت ظروف متعددة.

التكامل مع PHP Unit

بالإضافة إلى استخدام Postman، يمكنك دمج اختبارات API في سير عمل PHP Unit للاختبار التلقائي. ستحتاج إلى إعداد اختبارات باستخدام PHP Unit للتأكد من أن API تستجيب بشكل صحيح لكل سيناريو.


        <?php

        use PHPUnit\Framework\TestCase;


        class ApiTest extends TestCase {

           public function testGetRequest() {

              $response = file_get_contents('http://localhost/simple_api.php');

              $data = json_decode($response, true);


              // التحقق من أن الاستجابة تحتوي على البيانات المتوقعة

              $this->assertEquals('success', $data['status']);

              $this->assertEquals('Hello, world!', $data['data']);

           }

        }

        ?>

باستخدام Postman وPHP Unit معًا، يمكنك ضمان أن واجهات برمجة التطبيقات تعمل بشكل صحيح وتلبي المتطلبات المحددة.

الخلاصة

Postman هو أداة قوية لاختبار واجهات برمجة التطبيقات وتحليل الاستجابات. بدمج استخدام Postman مع PHP، يمكنك إنشاء بيئة اختبار شاملة تضمن أن الـ APIs الخاصة بك تعمل بشكل مثالي قبل إطلاقها. تأكد من اختبار جميع السيناريوهات الممكنة وإعداد اختبارات تلقائية لضمان الاستقرار والأمان.