كك Entwickler API، من المحتمل أنك على دراية بأداة Postman، وهي أداة شائعة لاختبار وأتمتة طلبات API. كانت أداة Postman Newman أداة مفضلة للعديد من المطورين لسنوات، لكنها ليست بدون قيود.
في هذا الدليل، سنغطي تثبيت واستخدام Newman، وهي أداة سطر أوامر مصممة لتشغيل مجموعات Postman. من خلال اتباع هذا الدليل، ستتعلم كيفية تثبيت Newman وتنفيذ مجموعات Postman، مما يمكنك من أتمتة عملية اختبار API الخاصة بك. أوصي بـ Apidog كبديل قوي.
ما هو Newman في Postman
Newman Postman هي أداة سطر أوامر تسمح للمطورين بتشغيل مجموعات Postman وبيئاتها في بيئة تكامل مستمر (CI). Postman هي أداة شائعة لتطوير API تسمح للمطورين بتصميم واختبار وتوثيق API. من ناحية أخرى، Newman هي أداة تسمح للمطورين بأتمتة اختبارات API باستخدام مجموعات وبيئات Postman.
مع Newman Postman، يستطيع المطورون بسهولة أتمتة اختبارات API والتأكد من أن APIs الخاصة بهم تعمل كما هو متوقع. يدعم Newman مجموعة من التكاملات والإضافات، مما يجعله أداة متعددة الاستخدامات لتطوير API. ومع ذلك، هناك بعض القيود على Newman Postman التي ينبغي على المطورين أن يكونوا على وعي بها، مثل تعقيد إعدادها وتكوينها، وبطء تنفيذ الاختبارات، والتكلفة للاستخدام على نطاق واسع.
ما الفرق بين Newman وPostman
Postman وNewman كلاهما أدوات لتطوير API، لكنهما يخدمان أغراضًا مختلفة. Postman هو تطبيق سطح مكتب يسمح للمطورين باختبار APIs بواجهة مستخدم رسومية (GUI). من ناحية أخرى، Newman هو أداة سطر أوامر تسمح للمطورين بتشغيل مجموعات Postman وبيئاتها في بيئة تكامل مستمر (CI)، مما يجعل أتمتة اختبارات API أسهل.
هناك فرق آخر بين Postman وNewman وهو التكلفة. تمتلك Postman نسخة مجانية لكنها تقدم أيضًا خطط مدفوعة مع ميزات إضافية. من ناحية أخرى، Newman هي أداة مفتوحة المصدر مجانية للاستخدام.
كيفية تشغيل مجموعة Postman في Newman؟
تثبيت Newman
تم بناء Newman على Node.js. لتشغيل Newman، تأكد من أن لديك Node.js مثبتًا. وNode.js >= v10. يمكنك تثبيت Node.js باستخدام مدير الحزم: https://nodejs.org/en/download/package-manager
استخدام NPM هو وسيلة شائعة وسهلة لتثبيت Newman. أدخل الأمر التالي في الطرفية.
$ npm install -g newman
باستخدام علامة "-g"، سيتم تثبيت Newman عالميًا على نظامك، مما يمكّنك من تشغيله من أي مكان.
تشغيل Newman
يمكنك استخدام الأمر "newman run" لتحديد المجموعة التي تريد تشغيلها. من السهل تصدير مجموعة Postman الخاصة بك كملف JSON من تطبيق Postman، ثم تنفيذها باستخدام Newman.
$ newman run mycollection.json
موصى بقراءته:
نصائح إضافية لـ Postman Newman
استخدام Newman مع CI/CD
يخرج Newman برمز حالة 0 بشكل افتراضي إذا تم تشغيل كل شيء بسلاسة دون أي استثناءات. للتأكد من أن أدوات التكامل المستمر (CI) الخاصة بك تستجيب لأكواد خروج Newman وتقبل أو ترفض البناء بناءً على ذلك، يمكنك تكوينها وفقًا لذلك.
بالإضافة إلى ذلك، يمكنك استخدام علامة "--bail" لجعل Newman يتوقف عن التشغيل إذا واجه خطأ في حالة الاختبار برمز حالة 1. يمكن بعد ذلك التقاط هذا الخطأ بواسطة أداة CI الخاصة بك أو نظام البناء والتصرف بناءً على ذلك.
استخدام Newman كمكتبة Node.js
يمكن أيضًا استخدام Newman كمكتبة Node.js، مما يسمح للمطورين بدمج اختبار API في تطبيقات Node.js الخاصة بهم. من خلال استخدام Newman كمكتبة، يمكن للمطورين تشغيل المجموعات برمجيًا، والوصول إلى نتائج الاختبار، ودمج الاختبار في عملية البناء الخاصة بهم.
const newman = require('newman'); // استيراد وحدة Newman
async function runCollection() {
try {
await newman.run({
collection: require('./sample-collection.json'),
reporters: 'cli'
});
console.log('تم اكتمال تشغيل المجموعة!');
} catch (err) {
console.error(err);
}
}
runCollection();
يستخدم هذا الكود المثال بناء الجملة async/await لجعل تشغيل Newman أكثر إيجازًا وقابلية للقراءة. فإنه يستورد وحدة Newman ويعرف دالة غير متزامنة تسمى runCollection لتشغيل المجموعة. داخل الدالة، يستخدم الكلمة الأساسية await للانتظار حتى ينتهي Newman من التشغيل، ثم يطبع رسالة تشير إلى أن المجموعة قد تم تشغيلها. إذا حدث خطأ، فإنه يلتقط الخطأ ويطبعه. أخيرًا، يتصل بدالة runCollection() لتشغيل البرنامج بالكامل.
بديل Postman Newman: Apidog
توفر Apidog دعمًا لتصدير حالات الاختبار إلى تنسيقات Apidog CLI وPostman وJMeter، مما يسهل دمج اختبار API في عملية التكامل المستمر الخاصة بك.
تم تصميم Apidog CLI خصيصًا لتشغيل حالات اختبار Apidog في سطر الأوامر، مما يوفر وسيلة سلسة لتنفيذ الاختبارات وأتمتة عملية الاختبار. من خلال تصدير حالات الاختبار إلى Apidog CLI، يمكن للمطورين دمج اختبار API بسهولة في عمليات البناء الخاصة بهم والتأكد من اختبار APIs بدقة وبشكل متسق.
بالإضافة إلى Apidog CLI، تدعم Apidog أيضًا تصدير حالات الاختبار إلى تنسيقات Postman وJMeter، مما يوفر للمطورين مرونة أكبر في نهجهم للاختبار. مع خيارات التصدير هذه، يمكن للمطورين اختيار أداة الاختبار التي تناسب احتياجاتهم ودمج اختبار API بسلاسة في سير العمل الخاص بتطويرهم.
كيفية تثبيت Apidog CLI
استخدم الأمر أدناه للتثبيت:
$ npm install -g apidog-cli
التشغيل ببيانات حقيقية
انتقل إلى "الاختبار"> "سيناريو الاختبار"، افتح API الذي تريده، وانقر على زر إضافة جديدة في صفحة CI/CD.
ثم، انسخ الأمر الذي تم إنشاؤه، وقم بتشغيله في سطر الأوامر.
apidog run http://xxx/api/v1/api-test/ci-config/xxxx/detail?token=xxxx -r html,cli
تشغيل حالات الاختبار
$ apidog run examples/sample.apidog-cli.json -r cli,html,json
سيتم حفظ تقرير الاختبار في دليل apidog-reports.
إذا كنت ترغب في تخصيص التقرير، يمكنك استخدام النتيجة في ملف JSON لتخصيص التقرير حسب الحاجة.
الخاتمة
من خلال اتباع الخطوات الموضحة في هذا الدليل، يجب أن تكون الآن لديك فكرة جيدة عن كيفية تثبيت وتشغيل Newman لتنفيذ مجموعات Postman. توفر Newman واجهة سطر أوامر تسمح بإجراء اختبارات API آلية، مما يجعلها أداة قيمة للمطورين الذين يعملون في بيئة تكامل مستمر.
ومع ذلك، إذا كنت تبحث عن بديل لـ Newman يوفر حل CI/CD أكثر قوة، أوصي بشدة بالنظر في Apidog. بالإضافة إلى واجهتها سهلة الاستخدام لاختبار API والتوثيق، تقدم Apidog أيضًا وظائف CI/CD قوية. مع ميزات مثل تصدير حالات الاختبار، وأدوات التعاون، وتوليد التوثيق التلقائي لـ API، والتكامل السلس مع خطوط أنابيب CI/CD، تقدم Apidog حلاً شاملاً لاحتياجات تطوير واختبار API.
سواء اخترت الاستمرار في استخدام Newman أو استكشاف Apidog كبديل، يمكن أن تعزز كلا الأداتين بشكل كبير عملية اختبار API الخاصة بك. ومع ذلك، إذا كنت تبحث عن حل أكثر شمولًا مع وظائف CI/CD قوية، فإن Apidog تستحق بالتأكيد التفكير فيها.