إذا لم تكن مألوفًا مع عميل REST الخاص بـ Postman، فهو أداة قوية تستخدم من قبل المطورين لاختبار وتوثيق واجهات برمجة التطبيقات (APIs). يوفر واجهة سهلة الاستخدام لإرسال طلبات HTTP، وتعيين المعلمات، وعرض الردود.
في هذا الدليل، سنرشدك خلال عملية استخدام Postman كعميل REST لإرسال الطلبات إلى واجهة برمجة التطبيقات. سنناقش كيفية إعداد Postman، كيفية إنشاء الطلبات، كيفية تعيين رؤوس الطلب والمعلمات، وكيفية عرض وتحليل الردود.
ما هو عميل REST الخاص بـ Postman؟
Postman هو عميل API يسهل عملية اختبار API. يتضمن Postman مجموعة متنوعة من أدوات API، بما في ذلك – تصميم، اختبار، محاكاة، مراقبة، وتوثيق اختبار API. تساعد هذه الأدوات في اكتشاف واجهات برمجة التطبيقات. مع واجهته السهلة الاستخدام، يمكن للمطورين بسهولة تصحيح واجهات REST من خلال فحص الردود، وتحديد الأخطاء، وحل المشكلات. يمكن استخدام Postman كتطبيق قابل للتنزيل أو على خادم الويب.
ما هو عميل Postman؟
يمكن لعميل Postman REST تمكين المستخدمين من تصور البيانات من خلال مُعَرض Postman من خلال رسومات ومخططات مُعدَّة مسبقًا، أو يمكن للمستخدم إنشاء تصوراته باستخدام المكتبات. تساعد ميزة إضافية الفرق في رؤية التصورات معًا واستخدامها كأساس لمزيد من تقدم المشروع. يحتوي عميل Postman أيضًا على دعم مدمج للمتحولات التي يمكن أن تخزن المتغيرات على مستوى عالمي. يمكن أيضًا إضافة المتغيرات إلى عناوين URL، والرؤوس، والجسم. يمكن للمستخدم أيضًا التبديل بين بيئات الإعداد دون تغيير طلبات API. يمكن أيضًا تخزين مفاتيح API على جهازك المحلي، بحيث لا يتم مزامنتها مع مشروع الفريق. بهذه الطريقة، تكون مفاتيح API متاحة فقط للمطورين.
يتيح Postman للمستخدم الوصول إلى بروتوكولات المصادقة دون الحاجة إلى إنشاء نسخ احتياطية. يدعم عميل Postman بروتوكولات AWS، مصادقة Hawk، و بروتوكولات OAuth 2.0. يمكن للمستخدم إدارة ملفات تعريف الارتباط وكذلك الشهادات. يتم استخدام ملفات تعريف الارتباط التي يتم إرجاعها من الخادم عند إرسال طلب لأغراض أخرى. يدعم عميل Postman عدة شهادات مثل شهادات SSL، وشهادات CA، ودعم الشهادات العميلة.
عميل Postman هو أكثر من مجرد عميل REST. يمكنه مساعدة المطورين في إنشاء مقتطفات من الرموز بلغات متنوعة. كما يسجل تاريخ الطلبات، ويمكن كتابة الاختبارات في Sandbox الخاص بـ Postman. تساعد الاختبارات المطور في بناء طلبات أفضل. ما بدأ كعميل REST قد تطور ليحقق تجربة أفضل للمستخدمين.
كيفية استخدام Postman كعميل REST لإرسال الطلبات
يمكن لـ Postman إنشاء وإرسال الطلبات إلى خادم ويب يرسل ردًا. لا يحتاج المستخدم إلى تنفيذ خطوات إضافية لإعداد الأطر لإنشاء أو إرسال أو استلام الطلبات باستخدام Postman.
بجانب إنشاء وإرسال الاقتراحات، توجد مجموعة متنوعة من الأدوات المفيدة في Postman، مثل فحص الرد، والتجريب، والأتمتة، وتنظيم الطلبات، والتعاون والمشاركة، والتوثيق. تشمل حالات الاستخدام الأخرى تطوير التطبيقات، توجيه المطورين الجدد، تطوير API أولاً، بوابات المطورين، والاختبار الاستكشافي والم automated.
الخطوات العامة لاستخدام Postman:
تحميل عميل Postman
قم بتحميل وتثبيت عميل Postman من الموقع الرسمي على Chrome (https://www.postman.com/downloads/) لنظام التشغيل الخاص بك.
قم بتشغيل التطبيق بعد التثبيت وأنشئ حسابًا أو قم بتسجيل الدخول للبدء باستخدام التطبيق إذا كان حسابك موجودًا بالفعل.
بعد إنشاء حساب، انقر على شروط الاتفاقية، وسيظهر لك موجه لفتح التطبيق على سطح المكتب. ستستقبل نافذة ترحيبية تطلب منك ملء اسمك ودورك كمطور. بمجرد اختيار تلك الخيارات، ستظهر لك نافذة مثل هذه:
يمكنك الآن البدء باستخدام Postman!
إنشاء طلب
يمكنك إنشاء طلب من خلال تحديد طريقة HTTP (GET، POST، PUT، DELETE) لطلب API. بعد ذلك، تحتاج إلى ملء عنوان URL الخاص بالنقطة النهائية التي تريد التفاعل معها واختيار الرؤوس والجسم والمعلمات المطلوبة للطلب. إذا كان API يتطلب مصادقة، يجب تكوين تفاصيل المصادقة.
إرسال الطلب
انقر على زر الإرسال لتنفيذ طلب API. سيقوم Postman بإرسال الطلب إلى النقطة النهائية وإنشاء رد.
عرض الرد
سيظهر Postman الرد المستلم من الخادم. يمكنك عرض رمز الحالة، الرأس، الجسم، نتائج الاختبار، وملفات تعريف الارتباط. يمكن عرض جسم الرد في العديد من التنسيقات، بما في ذلك (JSON، XML، وraw) لفهم أفضل من قبل المطور أو المختبر.
الاختبار والأتمتة
انقر على قسم API لاختيار عنوان الاختبار والأتمتة لاختبار API. طريقة بديلة للاختبار هي النقر على علامة التبويب "الاختبارات" وكتابة نصوص مستندة إلى JavaScript. يمكن التحقق من صحة هذه الاختبارات من خلال فحص رمز الحالة، والتحقق من هياكل JSON، وما إلى ذلك. يمكن تنفيذ الاختبارات من خلال النقر على زر "إرسال"، وسَتُعرض نتائج الاختبار على الشاشة.
البيئة والمتغيرات
يمكنك استخدام البيئات لإدارة المتغيرات التي يمكن استخدامها لإدارة الطلبات من خلال تحديد متغيرات محددة بيئيًا مثل عناوين URL والتوكنات. يمكنك أيضًا تبديل البيئات للعمل بشكل أفضل مع تكوينات مختلفة.
التوثيق
يمكن أن يساعد التوثيق في إضافة أوصاف، مقتطفات برمجية، وتفاصيل طلبات الAPI إلى الوثيقة، والتي يمكن نشرها ومشاركتها مع الآخرين. يمكنك أيضًا إنشاء توثيق API من الطلبات والردود المستلمة. يساعد هذا في تحسين استهلاك واجهات برمجة التطبيقات.
Apidog: منصة API أفضل من عميل Postman
ما هو Apidog؟
مثل Postman، Apidog هو منصة دمج API يمكن أن تختبر، تصحح، تصمم، تحاكي، وتوثق واجهات API. يوفر للمستخدم العديد من الأدوات للعمل بها. يساعد الفرق على العمل معًا والتعاون في مشاريع مختلفة. يمكن اختبار واجهات API بشكل أفضل، ويمكن إنشاء مخططات JSON/XML لنتائج الاختبار والردود.
تشمل الميزات المضمنة في Apidog توثيق ردود ونتائج API مع خيار تخصيص التخطيطات لجعل الوثيقة جذابة. تتضمن أدوات اختبار API إضافة توقعات بشكل مرئي وإنشاء فروع اختبار، والتعاون ومشاركة المشاريع مع أعضاء الفريق الآخرين لتسهيل العمل على واجهات API الجماعية، وتحليل واجهات API لمراقبة النشاط، والمحاكاة دون كتابة نصوص.
الميزات في Apidog
يمزج Apidog بسلاسة جميع احتياجات اختبار API في منصة واحدة. بخلاف الميزات الأساسية لإنشاء، إرسال، واختبار واجهات API، يتضمن Apidog ميزات متقدمة. يوفر "دعم متعدد البروتوكولات"، مما يساعد في إنشاء، شحن، وتنظيم الطلبات دون الحاجة لتبديل التطبيقات.
يساعد في "التصميم أثناء التصحيح"، مما يسمح للمطورين بتصحيح واجهات API أثناء العمل على تعديلاتهم في الوقت نفسه. تساعد "إضافة IDEA من Apidog" مطوري الخلفية في دمج المواصفات من تعليقات Javadoc دون الحاجة إلى إضافة تعليقات توضيحية. إحدى الميزات المفيدة الأخرى في Apidog تشمل "الاتصال بقاعدة بيانات"، والتي تتيح استرداد البيانات مباشرة من قواعد البيانات مثل MySQL، Oracle، MongoDB، إلخ.
واحدة من أكثر التكاملات قيمة في Apidog هي توافقه مع Postman. هذا يعني أنه يمكن تشغيل نصوص Postman (سواء كانت عامة أو خاصة) مباشرة في Apidog دون الحاجة إلى تعديلات. يوفر Apidog "مركز API"، والذي يسمح بالوصول إلى مئات وآلاف واجهات API العامة وخيار نشر واجهات API الخاصة بك.
مع ميزاته المتقدمة، اكتسب Apidog بسرعة شعبيته بين المطورين. إنه من بين أفضل منصات API.
كيف يعمل Apidog؟
التثبيت:
افتح موقع Apidog (https://apidog.com/)، والذي سيعطيك خيار التحميل. بعد التحميل، قم بتثبيت التطبيق على جهازك، أو استخدم موقع Apidog لإنشاء واجهات API عبر الإنترنت.
إنشاء حساب:
بعد تثبيت التطبيق، يجب عليك إنشاء حساب أو تسجيل الدخول إلى حساب موجود.
بعد إنشاء حساب، سيظهر لك موجه ترحيبي وسيطلب منك اختيار دور كمطور.
إنشاء واجهة API
يمكنك اختيار إنشاء مشروع جديد لبناء واجهة API. ستحتاج إلى تحديد نوع المشروع إما HTTP أو gRPC. بمجرد بدء المشروع، يمكنك اختيار إنشاء واجهة API.
إرسال طلب
يمكنك اختيار نوع الطلب (GET، POST، PUT، DELETE). بعد حفظ واجهة API الخاصة بك، يمكنك إرسال طلب إلى الخادم، بعد ذلك ستستقبل ردًا. يمكنك اختيار الخيارات للتصحيح أو التصميم.
فحص الردود
يمكنك عرض رمز حالة الرد، الجسم، الرأس، المعالجات المسبقة، المعالجات اللاحقة، وملفات تعريف الارتباط للرد من الخادم. يمكن رؤية جسم الرد في العديد من التنسيقات، مثل JSON/XML.
اختبار واجهة API الخاصة بك
في Apidog، يمكنك اختيار وإنشاء سيناريوهات اختبار متعددة وعرض تقارير الاختبار لهذه السيناريوهات. يتطلب إضافة سيناريو اختبار جديد اسم السيناريو، الأولوية، والوصف بشأن حالة الاختبار.
بعد إضافة اختبار، يمكنك إجراء خطوات الاختبار وإضافة التكامل المستمر والتسليم.
يمكن للمطور أيضًا عرض تقارير الاختبار لفهم نتائج الاختبار بشكل أفضل وتحسين واجهات API.
يمكن للمستخدم إضافة بيانات اختبار لرؤية نتائج واجهات API باستخدام بيانات فعلية.
التعاون
يتيح Apidog للمستخدم إنشاء مشاريع تعاونية ومشاركة الوثائق مع أعضاء الفريق العاملين على نفس المشروع. يسمح ذلك بتواصل أفضل مع جميع أعضاء الفريق.
الخاتمة
بشكل عام، مع ميزات Apidog المبتكرة، مثل إضافات IDEA، التعاون غير المحدود بين الأقران، تصميم التخطيط أولاً، التصحيح والتصميم المتزامنين، مراكز API لاستكشاف العديد من واجهات API العامة، توافق مع Postman، ودعم متعدد البروتوكولات، أثبت أنه أفضل عميل API في عصر اليوم متفوقًا على عميل Postman.