فاحص صحة API

بمساعدة الخادم اختبار واجهات API

الصق حتى 10 عناوين URL عامة لإجراء مسح صحي: تُفحص كل نقطة من حيث رمز الحالة وزمن الاستجابة ونص متوقّع في الجسم اختيارياً، مع ملخّص مرمّز بالألوان.

الخصوصية: ترسل هذه الأداة الطلب عبر خادم متقن للوصول إلى الهدف. يُنقل فقط العنوان والترويسات والمحتوى الذي تدخله، ولا يُحفظ أي شيء.

ما هو اختبار واجهات API؟

اختبار واجهات API يفحص الخدمة عبر واجهتها لا عبر شاشاتها: أرسل طلباً بأسلوب وترويسات وجسم مختارة، ثم تحقق من رمز الحالة وترويسات الاستجابة وبنية الجسم وقيمه والوقت المستغرق. ولأنه يعمل تحت واجهة المستخدم، فهو أسرع وأكثر استقراراً ويكشف عيوب التكامل مبكراً — ولهذا تُبنى حزم الانحدار على مستوى API أولاً.

اقرأ الدليل: ما هو اختبار API؟ وكيف تختبر REST API

كيفية استخدام فاحص صحة API

  1. الصق عنوان URL واحداً في كل سطر (نقاط نهاية عامة للصحة أو الجاهزية أو الإصدار).
  2. اختيارياً حدّد النص الذي يجب أن يحتويه الجسم وحدّ البطء.
  3. شغّل الفحص وراجع الملخّص، ثم جدول النتائج لكل نقطة نهاية.
  4. نزّل ملف CSV أو انسخ تقرير Markdown.

مزايا فاحص صحة API

  • فحص حتى 10 نقاط نهاية صحية في مسح واحد عبر المُرحِّل
  • الحالة وزمن الاستجابة والحجم ونص متوقّع في الجسم اختيارياً لكل نقطة نهاية
  • حكم UP / SLOW / FAIL / DOWN لكل نقطة نهاية (FAIL: الحالة ليست 2xx/3xx أو النص المتوقّع غير موجود؛ DOWN: تعذّر الوصول) مع حدّ بطء قابل للضبط
  • إحصاءات موجزة وتقرير Markdown جاهز للصقه في تحديث حالة
  • تصدير جدول النتائج بصيغة CSV

مثال على فاحص صحة API

مسح ثلاث خدمات

الإدخال:

https://httpbin.org/status/200
https://httpbin.org/delay/1
https://httpbin.org/status/503

النتيجة:

Healthy 1 · Slow 1 · Failing 1 · Avg latency 780 ms
UP    https://httpbin.org/status/200   200 OK   190 ms
SLOW  https://httpbin.org/delay/1       200 OK   1.2 s
FAIL  https://httpbin.org/status/503   503 Service Unavailable

الأسئلة الشائعة حول فاحص صحة API

كم عدد عناوين URL التي يمكنني فحصها؟

حتى 10 في كل مسح. يُجلب كل عنوان URL عبر المُرحِّل بمهلة قصيرة ويُبلَّغ عنه بالحالة وزمن الاستجابة والحجم.

ما الذي يُعدّ سليماً؟

حالة 2xx/3xx ضمن المهلة — وإذا حدّدت نصاً متوقّعاً في الجسم فيجب أن يحتويه الجسم. أما الاستجابات الأبطأ من الحدّ الذي ضبطته فتُعلَّم بأنها بطيئة (SLOW).

هل يمكنني المراقبة باستمرار؟

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

لماذا تظهر نقطة نهاية بحالة DOWN رغم أنها تعمل في متصفحي؟

يصل المُرحِّل إلى العناوين العامة فقط؛ فلا يمكن فحص الخدمات الداخلية أو المتاحة عبر VPN فقط أو خدمات localhost.

ملاحظات تقنية

يفحص المُرحِّل عناوين URL بالتوازي بمهلة قصيرة ويعيد الحالة والزمن والحجم لكل عنوان؛ أما نقاط النهاية التي يتعذّر الوصول إليها فتحمل رسالة خطأ بدلاً من الحالة.

المراجع

  • RFC 9110: HTTP SemanticsIETF · 2022معاني أساليب HTTP وحقول الترويسات ورموز الحالة والتفاوض على المحتوى، بغضّ النظر عن إصدار البروتوكول.
  • OpenAPI SpecificationOpenAPI Initiativeالمعيار لوصف واجهات REST: المسارات والعمليات والمعاملات والمخططات والاستجابات وأنظمة الأمان.
  • OWASP Cheat Sheet Series: REST SecurityOWASP Foundationالقواعد الأمنية لواجهات REST: HTTPS، والتوثيق في كل طلب، والتحقق من المدخلات، واستجابات الخطأ الآمنة، وتحديد المعدل.