نبني واجهات برمجة التطبيقات كل يوم، والحاجة إلى الأتمتة، والاختبار، والتنسيق هي أمر بالغ الأهمية. قدمت Postman، الأداة المعروفة بواجهة المستخدم السهلة الاستخدام، واجهتها الخاصة بسطر الأوامر (CLI) لدعم الأتمتة العميقة وتدفقات CI/CD.
لا تعد Postman CLI مجرد أداة لتحفيز الاختبارات؛ إنها أداة واسعة تسمح لك بكتابة تفاعلات واجهة برمجة التطبيقات، التكامل مع خطوط الأنابيب الحالية، وضمان سلامة واجهات برمجة التطبيقات عبر بيئات متعددة. يتناول هذا المقال القدرات المتقدمة لـ Postman CLI، موضحًا كيف يمكن أن elevate ممارسات تطوير واختبار واجهات برمجة التطبيقات الخاصة بك.
تطور واجهة سطر أوامر Postman
قبل الغوص في التفاصيل التقنية، من المهم أن نفهم لماذا قدمت Postman واجهة سطر الأوامر الخاصة بها. إن واجهة Postman الرسومية مثالية للاستخدام التفاعلي - مثالية لاستكشاف واختبار وإصلاح واجهات برمجة التطبيقات.
ومع ذلك، في بيئة DevOps الحديثة، تعتبر الأتمتة أمرًا حيويًا. تتطلب خطوط أنابيب التكامل المستمر / النشر المستمر (CI/CD) الاختبار الآلي والتحقق من سلامة واجهات برمجة التطبيقات، وهنا تأتي واجهة سطر الأوامر من Postman. إنها تربط الفجوة بين اختبار واجهة برمجة التطبيقات اليدوي وتدفقات العمل المدمجة، المؤتمتة تمامًا. تتيح هذه الأداة للفرق تشغيل المجموعات، والاختبارات، والتكاملات مباشرة من وحدة التحكم، مما يفتح إمكانيات العمليات الفعالة والقابلة للتكرار في بيئة مؤتمتة.
كيفية تثبيت وإعداد واجهة سطر الأوامر من Postman؟
واجهة سطر الأوامر من Postman ليست أداة مستقلة؛ إنها تتطلب بيئة مكونة، عادةً مع مفتاح API من Postman للتحقق من الوصول إلى مساحة العمل والمجموعات والبيئات الخاصة بك. هذا أمر حيوي لتنفيذ النصوص بشكل آمن وسلس في البيئات، خاصةً عند التكامل مع منصات CI/CD.
سيتعين علينا تثبيت واجهة سطر الأوامر لإعدادها. تحتوي وثائق Postman على دليل موثق جيد يمكن أن يساعد.
تثبيت Windows
قم بتشغيل الأوامر التالية لتثبيت واجهة سطر الأوامر من Postman لنظام Windows. سيقوم ذلك بتنزيل نص التثبيت وتشغيله. ينشئ نص التثبيت دليلًا %USERPROFILE%\AppData\Local\Microsoft\WindowsApps إذا لم يكن موجودًا بعد، ثم يقوم بتثبيت binary ل Postman هناك.
powershell.exe -NoProfile -InputFormat None -ExecutionPolicy AllSigned -Command "[System.Net.ServicePointManager]::SecurityProtocol = 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://dl-cli.pstmn.io/install/win64.ps1'))"
تثبيت Mac (معالج Apple)
قم بتشغيل الأمر التالي لتثبيت واجهة سطر الأوامر من Postman لأجهزة Mac الحاملة لمعالج Apple. سيقوم ذلك بتنزيل نص التثبيت وتشغيله. ينشئ نص التثبيت دليلًا /usr/local/bin إذا لم يكن موجودًا بعد، ثم يقوم بتثبيت binary ل Postman هناك.
curl -o- "https://dl-cli.pstmn.io/install/osx_arm64.sh" | sh
تثبيت Mac (انتل)
قم بتشغيل الأمر التالي لتثبيت واجهة سطر الأوامر من Postman لأجهزة Mac التي تحتوي على شرائح Intel. سيقوم ذلك بتنزيل نص التثبيت وتشغيله. ينشئ نص التثبيت دليلًا /usr/local/bin إذا لم يكن موجودًا بعد، ثم يقوم بتثبيت binary ل Postman هناك.
curl -o- "https://dl-cli.pstmn.io/install/osx_64.sh" | sh
تثبيت Linux
قم بتشغيل الأمر التالي لتثبيت واجهة سطر الأوامر من Postman لأحدث إصدار من Linux. سيقوم ذلك بتنزيل نص التثبيت وتشغيله. ينشئ نص التثبيت دليلًا /usr/local/bin إذا لم يكن موجودًا بعد، ثم يقوم بتثبيت binary ل Postman هناك.
curl -o- "https://dl-cli.pstmn.io/install/linux64.sh" | sh
بمجرد التثبيت، تحقق باستخدام مفتاح API من Postman، الذي يتم إدارته بشكل آمن بواسطة الخلفية الخاصة بـ Postman:
postman login --with-api-key ABCD-1234-1234-1234-1234-1234
يضمن هذا الإدارة لمفتاح API أن عمليات تنفيذ واجهة سطر الأوامر لها نفس مستوى الوصول والأمان مثل أي جلسة في واجهة Postman الويب أو سطح المكتب.
تشغيل المجموعات والبيئات
تسمح واجهة سطر الأوامر من Postman بتنفيذ المجموعات، وهي لب اختبار Postman. تمثل المجموعات في Postman سير العمل أو تسلسلات استدعاءات واجهة برمجة التطبيقات التي يجب اختبارها. غالبًا ما تكون مرتبطة بالبيئات، التي تخزن متغيرات مثل عناوين URL الأساسية، ورموز التحقق، أو أي تفاصيل تكوين أخرى تختلف عبر مراحل النشر (على سبيل المثال، التطوير، الاختبار، الإنتاج).
إحدى الميزات الأكثر تقدمًا هي القدرة على تشغيل مجموعة مع بيئة محددة. يسمح ذلك باختبار تدفقات API المعقدة في بيئات متعددة دون تعديل المجموعة نفسها:
postman run <collection.json> --environment <environment.json>
يسمح هذا الأمر البسيط ولكن القوي بتشغيل عدة مجموعات اختبارات عبر تكوينات مختلفة، مما يجعل واجهة سطر الأوامر لا تقدر بثمن لتنسيق اختبارات واجهات برمجة التطبيقات في خطوط أنابيب CI/CD.
التكوين المتقدم: متغيرات عالمية وبيئية
تعامل واجهة سطر الأوامر من Postman مع المتغيرات هي ميزة متقدمة أخرى. مع تقديم البيئات الديناميكية، يمكنك تجاوز وإدارة المتغيرات العالمية، والبيئية، والمحلية في الوقت الفعلي. هذه القدرة ضرورية لسير العمل المتقدمة حيث تحتاج عدة معلمات API إلى تغيير ديناميكي عبر مراحل الاختبار المختلفة.
فكر في سيناريو حيث تتطلب واجهة برمجة التطبيقات الخاصة بك رموز تحقق ديناميكية. بدلاً من ترميز الرموز بشكل ثابت، يمكنك حقنها ديناميكيًا باستخدام واجهة سطر الأوامر من Postman:
postman run <collection.json> --env-var token=<new_token>
في سيناريوهات أكثر تعقيدًا، قد ترغب في تحميل هذه القيم من ملفات خارجية، إدارتها عبر نصوص Pre-request للمجموعات في Postman، أو حتى تمريرها كمتغيرات بيئية أثناء التشغيل من منصة CI الخاصة بك. تجعل هذه المرونة واجهة سطر الأوامر من Postman قوية للغاية في التعامل مع تدفقات تحقق الهوية المتقدمة.
تنفيذ الاختبارات والتقارير المخصصة
تدعم واجهة سطر الأوامر من Postman تنفيذ مجموعات Postman المدمجة مع اختبارات آلية، مكتوبة بلغة JavaScript. يمكن لهذه الاختبارات التحقق من سلامة استجابات API، والتحقق من النماذج، أو مقارنة أوقات الاستجابة ضد العتبات المحددة مسبقًا.
عند تشغيل المجموعات، تقدم واجهة سطر الأوامر سجلًا وتقريرًا مفصلًا. بشكل افتراضي، يتم عرض الإخراج في تنسيق منظم يُظهر الاختبارات التي نجحت أو فشلت. ومع ذلك، فإن واجهة سطر الأوامر من Postman تتجاوز السجل الأساسي. يمكن للمستخدمين المتقدمين توليد تقارير مخصصة بعدة تنسيقات، بما في ذلك JSON، وHTML، وJUnit XML، وهو أمر حيوي للتكامل مع منصات CI مثل Jenkins أو GitLab:
postman run <collection.json> --reporters cli,json --reporter-json-export output.json
لا يقوم هذا الأمر فقط بتشغيل المجموعة ولكن أيضًا بإخراج النتائج بتنسيق CLI وJSON، مما يسمح بمزيد من المعالجة أو التكامل مع أدوات لوحة المعلومات.
غوص عميق: العمل مع Newman مقابل واجهة سطر الأوامر من Postman
قبل تقديم واجهة سطر الأوامر من Postman، كانت Newman هي الأداة المفضلة لتشغيل مجموعات Postman من سطر الأوامر. على الرغم من أن Newman لا زالت ذات صلة، خاصة لبعض سير العمل القديمة، إلا أن واجهة سطر الأوامر من Postman تقدم العديد من التحسينات. تتكامل مباشرة مع منصة Postman السحابية، مما يوفر مصادقة وإدارة بيئات أكثر سلاسة.
على سبيل المثال، يمكن لواجهة سطر الأوامر من Postman الوصول إلى مساحات العمل المشتركة مباشرة من سحاب Postman، مما يقضي على الحاجة لتنزيل وإدارة المجموعات والبيئات محليًا. كما أنها تدعم آليات المصداقية المتقدمة (OAuth2، رموز حاملها، إلخ) بشكل طبيعي من خلال تكوينات مساحة عمل Postman، مما يجعلها حلاً أكثر قوة لسير العمل المدمجة مع السحابة.
إليك مقارنة لتشغيل مجموعة بسيطة باستخدام Newman وواجهة سطر الأوامر من Postman:
Newman:
newman run <collection.json> --environment <environment.json>
Postman CLI:
postman run <collection>
تكمن الفرق الرئيسي هنا في قدرة واجهة سطر الأوامر من Postman على الإشارة إلى المجموعات والبيئات مباشرة من مساحة عمل Postman في السحابة، مما يجعلها أكثر مرونة للبيئات ذات الأمان العالي أو التكوينات المتغيرة بسرعة.
دمج واجهة سطر الأوامر من Postman في خطوط أنابيب CI/CD
أحد الأسباب الرئيسية لاستخدام واجهة سطر الأوامر من Postman هو تكاملها مع خطوط أنابيب CI/CD. في خط أنابيب، يصبح الاختبار الآلي لواجهات برمجة التطبيقات أمرًا حيويًا لاكتشاف المشكلات مبكرًا في دورة التطوير. يمكن لأدوات مثل Jenkins وCircleCI وGitLab CI وGitHub Actions استدعاء أوامر واجهة سطر الأوامر من Postman لتنفيذ اختبارات واجهة برمجة التطبيقات في مراحل متعددة من خط الأنابيب.
فConsider المثال التالي لدمج واجهة سطر الأوامر من Postman في خط أنابيب Jenkins:
pipeline {
agent any
stages {
stage('Run Postman Tests') {
steps {
script {
sh 'postman run <collection> --reporters cli,junit --reporter-junit-export results.xml'
}
}
}
}
post {
always {
junit 'results.xml'
}
}
}
يعمل هذا Jenkinsfile على تشغيل مجموعة Postman والتقاط نتائج الاختبار في تنسيق متوافق مع مكون Jenkins الإضافي JUnit، الذي يقوم بعد ذلك بإنشاء تقارير بناءً على نتائج الاختبارات.
تسمح واجهة سطر الأوامر من Postman أيضًا بالتحكم الأكثر دقة في تنفيذ الاختبارات داخل خطوط الأنابيب. على سبيل المثال، يمكنك تحديد تكرارات معينة لمجموعات الاختبارات، والتحكم في المهلات، وتكوين آليات إعادة المحاولة إذا فشل اختبار، مما يوفر بيئة اختبار قابلة للتخصيص بشكل كبير.
تعامل مع الأخطاء وتصحيح الأخطاء
يمكن أن تفشل اختبارات واجهة برمجة التطبيقات لأسباب عديدة، تتراوح بين عدم تطابق تنسيقات الاستجابة إلى تهيئة البيئات بشكل خاطئ. تدعم واجهة سطر الأوامر من Postman سجلًا تفصيليًا، وهو أمر ضروري لتصحيح مثل هذه المشكلات. باستخدام علامة --verbose، يمكن للمطورين الوصول إلى مستوى عميق من المعلومات، بما في ذلك رؤوس وأجسام الطلب والاستجابة، وأوقات التنفيذ.
postman run --verbose
عند دمجه في سير عمل CI/CD، تكون هذه الدرجة من التفاصيل لا تقدر بثمن. يمكن توجيه الإخراج التفصيلي إلى سجلات يمكن أن يحللها المطورون لتحديد ما إذا كانت المشكلة تكمن في واجهة برمجة التطبيقات نفسها، أو تكوين الاختبار، أو إعداد البيئة.
استكشاف Apidog CLI: تجربة سطر أوامر متفوقة للاختبار الآلي
بينما تعد واجهة سطر الأوامر من Postman شهيرة لأتمتة سير عمل واجهات برمجة التطبيقات، فإن Apidog CLI هي بديل قوي يقدم نهجًا قويًا ومرنًا للاختبار الآلي، مصمم خصيصًا لتبسيط تنفيذ سيناريوهات واجهة برمجة التطبيقات من سطر الأوامر. Apidog، المنافس لـ Postman، تقدم تجربة اختبار واجهة برمجة تطبيقات سلسة تستند إلى الأوامر مخصصة للمطورين الذين يحتاجون إلى حل سريع وآلي لاختبار سير العمل المعقدة في بيئات CI/CD.
لماذا Apidog CLI؟
توفر واجهة سطر الأوامر من Apidog جميع الإمكانيات اللازمة لأتمتة اختبار واجهات برمجة التطبيقات، مع تركيز خاص على سهولة الاستخدام، وخيارات التكوين المتقدمة، وقدرات التكامل القوية. تم تصميمها لتشغيل سيناريوهات اختبار Apidog من وحدة التحكم، مما يجعلها خيارًا ممتازًا للفرق التي ترغب في تضمين اختبار واجهة برمجة التطبيقات مباشرة في سير العمل الخاص بهم في التطوير والنشر. تتكامل واجهة سطر الأوامر بسهولة مع ميزات Apidog السحابية القوية ومُحسّنة لتشغيل سيناريوهات الاختبار في أي بيئة، مما يضمن ملاحظات سريعة حول سلامة واجهات برمجة التطبيقات عبر مراحل متعددة من خط الأنابيب الخاص بك.
إعداد واجهة سطر الأوامر من Apidog
للبدء في استخدام واجهة سطر الأوامر من Apidog، تأكد من أن بيئتك مجهزة بـ نسخة Node.js 16 أو أعلى. يمكن تثبيت واجهة سطر الأوامر من Apidog بسهولة عبر npm، مما يسمح لك بالبدء والتشغيل في بضع أوامر فقط:
npm install -g apidog-cli
بمجرد التثبيت، يكون التحقق من إعدادك أمرًا بسيطًا. يتحقق الأمر التالي من إصدار Node.js وإصدار CLI ومسارات تثبيت Node وnpm وApidog:
node -v && apidog -v && which node && which npm && which apidog
يضمن ذلك أن نظامك مكون بشكل صحيح لاستخدام واجهة سطر الأوامر من Apidog ويساعد في استكشاف أي مشكلات في الإعداد.
تشغيل سيناريوهات الاختبار في Apidog CLI
تم تصميم واجهة سطر الأوامر من Apidog لتشغيل سيناريوهات الاختبار بكفاءة، مما يوفر لك المرونة في كيفية المصادقة وتنفيذ الاختبارات. يمكنك تحديد سيناريو اختبار إما بمعرفه الفريد أو بالإشارة إلى مجلد يحتوي على مجموعة من سيناريوهات الاختبار. تبسط هذه الميزة تنفيذ اختبارات واجهة برمجة التطبيقات على نطاق واسع عبر بيئات متعددة وتكوينات.
إليك مثال على تشغيل سيناريو اختبار باستخدام رمز وصول Apidog:
apidog run --access-token <your-access-token> -t <test-scenario-id>
يقوم هذا الأمر بتشغيل سيناريو الاختبار بناءً على معرفه، بينما يتم تمرير بيانات الاعتماد للتحقق بشكل آمن عبر رمز الوصول. إذا كنت بحاجة لتشغيل جميع سيناريوهات الاختبار في مجلد معين، يمكنك ببساطة استخدام معرف المجلد بدلاً من ذلك:
apidog run --access-token <your-access-token> -f <test-scenario-folder-id>
خيارات CLI المتقدمة للتخصيص المفصل
تتمثل إحدى نقاط القوة في واجهة سطر الأوامر من Apidog في خيارات سطر الأوامر المتقدمة. يمكنك تكوين تقارير الاختبار، المتغيرات البيئية، شهادات SSL، وحتى تقديم تأخيرات أو مهلات بين الطلبات. يسمح Apidog بتحكم دقيق في عملية الاختبار الخاصة بك، سواء كنت تقوم بتشغيل سيناريو اختبار واحد أو تنفيذ مجموعة من الاختبارات بشكل تكراري عبر بيئات مختلفة.
إليك مثال على إنشاء تقرير مخصص بتنسيقات JSON وJUnit، وحفظه في دليل معين:
apidog run <collection> --reporters json,junit --out-dir ./test-reports
باستخدام واجهة سطر الأوامر من Apidog، يمكنك أيضًا تعريف المتغيرات البيئية ديناميكيًا، مما يضمن أن تكون سيناريوهات اختباراتك حساسة للسياق وقادرة على التكيف مع التغييرات في تكوينات واجهات برمجة التطبيقات دون تعديل النصوص الأساسية:
apidog run <collection> --env-var "BASE_URL=https://staging.api.com" --env-var "TOKEN=abc123"
تضمن هذه المرونة أن تتناسب واجهة سطر الأوامر من Apidog بشكل سلس في بنية الاختبار الحالية لديك.
شهادات SSL واختبار الأمان
في عالم اليوم، يعد التحقق من SSL أمرًا بالغ الأهمية عند اختبار واجهات برمجة التطبيقات. تدعم واجهة سطر الأوامر من Apidog تمرير شهادات العميل، مما يسمح باتصالات آمنة مع واجهات برمجة التطبيقات الخاصة بك أثناء الاختبارات. سواء كنت تستخدم شهادة واحدة أو عدة شهادات بناءً على مجالات معينة، فإن Apidog تبسط العملية. يمكنك تحديد شهادة عميل واحدة لاختباراتك:
apidog run <collection> --ssl-client-cert ./path/to/cert.pem --ssl-client-key ./path/to/key.pem
أو، في إعدادات أكثر تعقيدًا، يمكنك استخدام ملف JSON يحتوي على قائمة بشهادات العميل matched to URLs معينة:
apidog run <collection> --ssl-client-cert-list ./path/to/ssl-cert-list.json
لماذا الانتقال إلى Apidog؟
تقدم واجهة سطر الأوامر من Apidog تجربة معززة للفرق التي تبحث عن أداء أسرع، تكامل أسهل، وتحكم أكبر في سير عمل اختبار واجهات برمجة التطبيقات. توفر هذه الواجهة مرونة أدوات سطر أوامر قوية مع التكامل مع منصة Apidog الغنية بالميزات، مما يجعلها بديلاً قويًا لواجهة سطر الأوامر من Postman.
إذا كنت بالفعل على دراية بـ Postman، فسيبدو الانتقال إلى واجهة سطر الأوامر من Apidog بديهيًا، ولكنك ستلاحظ على الفور المرونة والقوة الإضافتين التي توفرها Apidog. مجموعتها الغنية من الميزات، جنبًا إلى جنب مع تقارير شاملة وإدارة ديناميكية للبيئات، تجعل Apidog منافسًا قويًا للمطورين الذين يحتاجون إلى حل فعال وقابل للتوسع لاختبار واجهات برمجة التطبيقات.
الخاتمة
في الختام، بينما كانت Postman لفترة طويلة عنصرًا أساسيًا في مجال اختبار واجهات برمجة التطبيقات، توفر واجهة سطر الأوامر من Apidog بديلاً قويًا مصممًا للعمل في سير العمل الحديثة والأوتوماتيكية. مع خيارات الأوامر المتقدمة، إدارة البيئة السلسة، وقدرات التقارير المرنة، تمكّن واجهة سطر الأوامر من Apidog الفرق من اختبار والتحقق من واجهات برمجة التطبيقات بكفاءة عبر مراحل مختلفة من التطوير والنشر. إذا كنت تبحث عن أداة قوية ومرنة تتكامل بسهولة في خطوط أنابيب CI/CD الخاصة بك، فإن واجهة سطر الأوامر من Apidog تستحق الاستكشاف. تقدم نهجًا مبسطًا لاختبار واجهات برمجة التطبيقات، مما يضمن أن تظل واجهات برمجة التطبيقات الخاصة بك موثوقة وآمنة وعالية الأداء.