كيفية إستخدام واجهة برمجة التطبيقات مع Postman – خطوة بخطوة

كيفية إستخدام واجهة برمجة التطبيقات مع Postman – خطوة بخطوة

مرحبا بمتابعي وزوار مدونة الشهادة مع مقال جديد بعنوان كيفية استخدام واجهة برمجة التطبيقات Postman – دليل خطوة بخطوة.

في مجال تطوير البرمجيات، أصبح الاتصال الفعال بين أنظمة البرمجيات المختلفة ممكنًا من خلال الوظيفة الأساسية لواجهات برمجة التطبيقات (APIs).

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

في هذا الدليل الشامل، سنستكشف كيفية استخدام Postman للتفاعل مع واجهات برمجة التطبيقات بشكل فعال.

1. ما هي واجهة برمجة التطبيقات (API)؟

قبل الغوص في Postman، دعونا نفهم بإيجاز ما هي واجهات برمجة التطبيقات (APIs).

واجهة برمجة التطبيقات (API)، أو واجهة برمجة التطبيقات، عبارة عن مجموعة من القواعد والأدوات التي تسمح لتطبيقات البرامج المختلفة بالتواصل مع بعضها البعض. تحدد واجهات برمجة التطبيقات الأساليب وتنسيقات البيانات التي يمكن للتطبيقات استخدامها لطلب المعلومات وتبادلها.

الآن، دعنا نستكشف بعض الأنواع الشائعة من واجهات برمجة التطبيقات (APIs) التي غالبًا ما يواجهها المطورون:

1. واجهات برمجة تطبيقات RESTful: نقل الحالة التمثيلية (REST) ​​هو نمط معماري لتصميم تطبيقات الشبكة. تستخدم واجهات برمجة التطبيقات RESTful أساليب HTTP القياسية (GET، POST، PUT، DELETE) لتنفيذ العمليات على الموارد. وهي عديمة الجنسية وتتبع بنية خادم العميل، مما يجعلها قابلة للتطوير وتستخدم على نطاق واسع لخدمات الويب.
2. GraphQL: GraphQL هي لغة استعلام لواجهات برمجة التطبيقات التي تسمح للعملاء بطلب البيانات التي يحتاجونها فقط. على عكس REST، الذي يكشف عن نقاط نهاية ثابتة للموارد، يوفر GraphQL طريقة أكثر مرونة وكفاءة للتفاعل مع واجهات برمجة التطبيقات، مما يجعله مناسبًا بشكل خاص لمتطلبات جلب البيانات المعقدة.

2. مقدمة لساعي البريد

Postman هي أداة تطوير واختبار API شائعة توفر واجهة سهلة الاستخدام للعمل مع واجهات برمجة التطبيقات. فهو يسمح للمطورين بإنشاء طلبات واجهة برمجة التطبيقات (API) واختبارها وإدارتها دون عناء.

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

3. كيفية تثبيت ساعي البريد

للبدء في استخدام Postman، عليك أولاً تثبيته على جهازك. Postman متاح لأنظمة التشغيل Windows وmacOS وLinux. قم بزيارة الموقع الرسمي لـ Postman لتنزيل التطبيق.

بمجرد التنزيل، اتبع تعليمات التثبيت لنظام التشغيل الخاص بك. اتبع تعليمات التثبيت، وإذا واجهت أية مشكلات، ففكر في النصائح التالية لاستكشاف الأخطاء وإصلاحها:

• التحقق من الاتصال بالإنترنت: تأكد من أن اتصالك بالإنترنت مستقر، حيث يتطلب Postman الاتصال بالإنترنت للتثبيت.
• إعدادات جدار الحماية: اضبط إعدادات جدار الحماية لديك للسماح لـ Postman بالوصول إلى الإنترنت.
• برنامج مكافحة الفيروسات: قم بتعطيل برنامج مكافحة الفيروسات مؤقتًا أثناء التثبيت، لأنه قد يتداخل مع العملية.

4. كيفية إنشاء حساب ساعي البريد

بينما يمكنك استخدام Postman بدون حساب، فإن إنشاء حساب يأتي مع العديد من الفوائد.

يتيح لك حساب Postman مزامنة عملك عبر أجهزة متعددة، والتعاون مع أعضاء الفريق، والوصول إلى ميزات إضافية.

وفيما يلي الخطوط العريضة للمزايا:

• المزامنة: قم بمزامنة عملك عبر أجهزة متعددة، مما يضمن الاتساق في بيئة تطوير واجهة برمجة التطبيقات (API) الخاصة بك.
• التعاون: التعاون مع أعضاء الفريق من خلال مشاركة المجموعات وبرامج الاختبار والبيئات.
• ميزات إضافية: الوصول إلى الميزات المتقدمة مثل المراقبة والتحكم في الإصدار والتعاون الجماعي.

لإنشاء حساب، انقر فوق الزر “تسجيل” الموجود على موقع Postman واتبع عملية التسجيل.

5. كيفية تقديم طلب API الأول الخاص بك

بعد تثبيت Postman وإنشاء حساب (إذا رغبت في ذلك)، حان الوقت لتقديم أول طلب لواجهة برمجة التطبيقات (API). افتح Postman وسيتم الترحيب بك بواجهة نظيفة وبديهية.

اتبع هذه الخطوات لتقديم طلب GET بسيط:

• انقر فوق الزر “+” لإنشاء علامة تبويب طلب جديدة

• أدخل نقطة نهاية واجهة برمجة التطبيقات: في شريط URL، أدخل نقطة نهاية واجهة برمجة التطبيقات التي تريد التفاعل معها. على سبيل المثال يمكن أن يكون واجهة برمجة تطبيقات الطقس مثل https://api.openweathermap.org/data/2.5/weather.

• إرسال الطلب: الضغط على زر “إرسال” لتنفيذ الطلب. سيعرض Postman الرد من واجهة برمجة التطبيقات (API).

تهانينا! لقد قمت للتو بتقديم أول طلب لواجهة برمجة التطبيقات (API) باستخدام Postman.

6. كيفية العمل مع أساليب HTTP

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

• طلبات الحصول على: استرداد البيانات من الخادم.
• طلبات POST: إرسال البيانات لإنشاء مورد جديد.
• طلبات PUT: تحديث مورد أو إنشاء مورد جديد إذا لم يكن موجودًا.
• طلبات الحذف: حذف مورد على الخادم.

6.1 كيفية إنشاء طلبات GET

تُستخدم طلبات GET لاسترداد المعلومات من الخادم. في Postman، اتبع الخطوات المذكورة سابقًا لتقديم طلب GET.

6.2 كيفية إنشاء طلبات POST

تُستخدم طلبات POST لإرسال البيانات إلى الخادم لإنشاء مورد جديد. فيما يلي مثال على تقديم طلب POST:

Request Type: POST
URL: https://api.example.com/users
Body:
{
  "name": "John Doe",
  "email": "john@example.com"
}

6.3 كيفية إنشاء طلبات PUT

تُستخدم طلبات PUT لتحديث مورد أو إنشاء مورد جديد إذا لم يكن موجودًا. مثال لطلب PUT:

Request Type: PUT
URL: https://api.example.com/users/1
Body:
{
  "name": "Updated Name"
}

6.4 كيفية إنشاء طلبات الحذف

تُستخدم طلبات الحذف لحذف مورد على الخادم. مثال:

Request Type: DELETE
URL: https://api.example.com/users/1

7. كيفية التعامل مع معلمات الطلب

غالبًا ما تتطلب واجهات برمجة التطبيقات معلومات إضافية لمعالجة الطلبات. يتيح لك Postman تضمين المعلمات بطرق مختلفة. يشملوا:

• معلمات الاستعلام: تستخدم لتصفية البيانات أو فرزها في عنوان URL.
• رؤوس الطلب: توفير معلومات إضافية حول الطلب أو العميل.
• نص الطلب: يحتوي على بيانات لطلبات POST وPUT.

7.1 ما هي معلمات الاستعلام؟

يتم تضمين معلمات الاستعلام في عنوان URL ويتم استخدامها لتصفية البيانات أو فرزها. على سبيل المثال:

URL: https://api.example.com/products?category=electronics&price=100

7.2 ما هي رؤوس الطلبات؟

توفر الرؤوس معلومات إضافية حول الطلب أو العميل. في Postman، يمكنك إضافة رؤوس في علامة تبويب الرؤوس.

Key: Authorization
Value: Bearer YourAccessToken

7.3 ما هي هيئة الطلب؟

بالنسبة لطلبات POST وPUT، غالبًا ما يتم إرسال البيانات في نص الطلب. في Postman، قم بالتبديل إلى علامة تبويب النص واختر تنسيق البيانات (على سبيل المثال، JSON أو بيانات النموذج) قبل إدخال البيانات.

8. كيفية المصادقة في ساعي البريد

يدعم Postman طرق مصادقة مختلفة لتأمين طلبات واجهة برمجة التطبيقات (API) الخاصة بك. المصادقة أمر بالغ الأهمية لأمن API. ساعي البريد يدعم:

• مفاتيح واجهة برمجة التطبيقات (API Keys): قم بتضمين مفاتيح واجهة برمجة التطبيقات (API) في رؤوس الطلبات.
• الرموز المميزة لحاملها: قم بالمصادقة باستخدام الرموز المميزة في رأس التفويض.

8.1 كيفية المصادقة باستخدام مفاتيح API

إذا كانت واجهة برمجة التطبيقات (API) تتطلب مفتاح واجهة برمجة التطبيقات (API) للمصادقة، فيمكنك تضمينه في رؤوس الطلب. على سبيل المثال:

Key: X-API-Key
Value: YourAPIKey

8.2 كيفية المصادقة باستخدام Bearer Tokens

بالنسبة لواجهات برمجة التطبيقات التي تستخدم المصادقة المستندة إلى الرمز المميز، يمكنك تضمين الرمز المميز في رأس التفويض.

Key: Authorization
Value: Bearer YourAccessToken

9. كيفية تنظيم الطلبات مع التحصيلات

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

لإنشاء مجموعة، انقر فوق الزر “جديد” في الشريط الجانبي الأيسر واختر “المجموعة”. قم بتسمية مجموعتك وابدأ في إضافة الطلبات إليها.

10. كيفية أتمتة سير العمل باستخدام البرامج النصية لـ Postman

يدعم Postman البرامج النصية المكتوبة بلغة JavaScript، والتي يمكن استخدامها لأتمتة المهام وتحسين سير عملك. يمكنك إضافة برامج نصية إلى أجزاء مختلفة من الطلب، مثل البرامج النصية للطلب المسبق أو البرامج النصية للاختبار.

فيما يلي مثال بسيط لنص برمجي للطلب المسبق يقوم بإنشاء طابع زمني ويتضمنه في رؤوس الطلب:

// Pre-request Script
const timestamp = new

 Date().getTime();
pm.request.headers.add({ key: 'Timestamp', value: timestamp });

11. كيفية اختبار واجهات برمجة التطبيقات مع Postman

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

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

11.1 كيفية كتابة نصوص الاختبار

يمكن إضافة البرامج النصية للاختبار إلى علامة التبويب الاختبارات الخاصة بالطلب. فيما يلي مثال لبرنامج نصي اختباري بسيط يتحقق مما إذا كانت حالة الاستجابة هي 200:

// Test Script
pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});

11.2 كيفية إجراء الاختبارات

بعد كتابة البرامج النصية للاختبار، يمكنك تشغيلها بالنقر فوق الزر “إرسال”. سيقوم ساعي البريد بتنفيذ الطلب وعرض نتائج الاختبارات في علامة التبويب نتائج الاختبار.

12. كيفية مراقبة واجهات برمجة التطبيقات مع Postman

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

لإعداد المراقبة، انتقل إلى علامة التبويب “الشاشة” وقم بإنشاء شاشة جديدة. حدد المجموعة المراد مراقبتها، وحدد الجدول الزمني، وسيتولى Postman الباقي.

جدولة المجموعات ليتم تشغيلها على فترات زمنية، مما يسمح لك بما يلي:

• تحديد مشكلات الأداء: اكتشاف الحالات الشاذة في أوقات الاستجابة.
• ضمان الموثوقية: مراقبة الأخطاء أو السلوك غير المتوقع.

13. كيفية تصدير واستيراد بيانات ساعي البريد

يتيح لك Postman تصدير مجموعاتك وبيئاتك وبياناتك الأخرى لأغراض المشاركة أو النسخ الاحتياطي. للتصدير، انتقل إلى أيقونة “الإعدادات” في الزاوية العلوية اليمنى وحدد “تصدير”.

لاستيراد البيانات، استخدم خيار “استيراد” في القائمة نفسها. يمكنك استيراد المجموعات والبيئات وتفريغ البيانات من أدوات أخرى.

14. كيفية التعاون مع ساعي البريد

يعد التعاون جانبًا رئيسيًا في تطوير البرمجيات، ويوفر Postman ميزات لتسهيل العمل الجماعي. يمكنك مشاركة المجموعات مع أعضاء الفريق، والتعليق على الطلبات، واستخدام ميزات التعاون المضمنة.

للتعاون في مجموعة ما، انقر فوق الزر “مشاركة” في الزاوية العلوية اليمنى. يمكنك إنشاء رابط للمشاركة أو دعوة أعضاء الفريق مباشرة.

15. كيفية استكشاف المشكلات الشائعة وإصلاحها

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

إذا واجهت مشاكل في المصادقة، فتحقق جيدًا من بيانات الاعتماد الخاصة بك وتأكد من تكوينها بشكل صحيح في Postman.

اتبع قائمة التحقق هذه لاستكشاف المشكلات الشائعة المتعلقة بواجهة برمجة التطبيقات وإصلاحها:

1. تحقق من الاتصال بالإنترنت: تأكد من وجود اتصال مستقر بالإنترنت.
2. جدار الحماية ومكافحة الفيروسات: اضبط الإعدادات للسماح بوصول ساعي البريد.
3. نقطة نهاية واجهة برمجة التطبيقات: تحقق من صحة نقطة نهاية واجهة برمجة التطبيقات.
4. بيانات اعتماد المصادقة: تحقق جيدًا من مفاتيح API أو الرموز المميزة.
5. بنية الطلب: تأكد من البنية الصحيحة لطلبات واجهة برمجة التطبيقات (API) الخاصة بك.

16. الاستنتاج

في هذا الدليل الشامل، قمنا بتغطية أساسيات استخدام Postman للتفاعل مع واجهات برمجة التطبيقات.

بدءًا من تقديم طلبات بسيطة وحتى تنظيم سير العمل مع المجموعات وكتابة نصوص الاختبار، يقدم Postman بيئة متعددة الاستخدامات وسهلة الاستخدام لتطوير واجهة برمجة التطبيقات (API) واختبارها.

سواء كنت مبتدئًا أو مطورًا ذا خبرة، فإن إتقان Postman يمكن أن يعزز إنتاجيتك بشكل كبير في العمل مع واجهات برمجة التطبيقات. ابدأ في استكشاف الميزات المذكورة في هذا الدليل، وقم بتجربة واجهات برمجة التطبيقات المختلفة، وقم ببناء كفاءتك تدريجيًا في استخدام Postman لتبسيط عملية التطوير الخاصة بك.

نسعى دائما لتقديم كل ماهو ممتع لكم فاتمنى ان نكون عند حسن ظنكم جميعا.

فارجو دعمنا وتشجيعنا على تقديم الافضل بمشاركة الموضوع مع اصدقائكم على مواقع التواصل الاجتماعى فيس بوك تويتر عن طريق ازرار المشاركة اسفل التدوينة.

وترك تعليق داخل صندوق التعليقات تشجيعاُ لنا كل الود والاحترام لكم والى اللقاء فى تدوينة اخرى من تدوينات مدونة الشهادة .