كيف تختبر واجهات REST API في VS Code

بقلم Sayaib Sarkarآخر تحديث قراءة في 4 دقيقة

في هذه الصفحة 7 قسم

الإجابة المختصرة: ثبّت إضافة عميل REST، وافتحها بجوار شيفرتك، وأرسل الطلبات من هناك. يستخدم هذا الدليل REST API Client المجاني في DevSnip Pro: دون حساب، ومع البيئات والمجموعات واستيراد cURL وتوليد الشيفرة. والعادات التي يصفها تصلح مع أي عميل.

REST API Client في DevSnip Pro داخل VS Code: طلب GET مع استجابة JSON منسقة والحالة والوقت والحجم

التنقل بين محررك وأداة API منفصلة يكلّف أكثر مما يبدو: تنسخ عنوان URL من الشيفرة، وتلصق رمزًا من ملف .env، وترسل، ثم تنسخ JSON عائدًا لتكتب نوعًا أو اختبارًا. أما داخل VS Code، فتبقى الشيفرة والطلب والاستجابة متجاورة.

1. أرسل طلبك الأول

  1. شغّل DevSnip Pro: REST API Client من لوحة الأوامر (Ctrl/Cmd+Shift+P)، أو انقره في الشريط الجانبي لـ DevSnip Pro.
  2. انقر Send a sample request. يرسل GET https://jsonplaceholder.typicode.com/todos/1، وهي واجهة اختبار عامة مجانية.
  3. تعرض لوحة الاستجابة الحالة والوقت والحجم، وJSON منسقًا قابلًا للبحث، والترويسات وملفات تعريف الارتباط.

لواجهتك أنت، اكتب عنوان URL واضغط Enter. وإذا كان الطلب لديك بالفعل كأمر cURL (أدوات المطوّر في المتصفح: Copy as cURL)، فالصقه في شريط العنوان: تُستورد الطريقة والترويسات والجسم.

2. توقّف عن كتابة المضيفين والرموز في الشيفرة

أنشئ بيئة لكل هدف، مثل local وstaging، فيها متغيرات مثل baseUrl وtoken. ثم اكتب الطلبات هكذا:

الشيفرة
GET {{baseUrl}}/users/42
Authorization: Bearer {{token}}

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

3. احفظ ما ستشغّله مجددًا

احفظ الطلبات في مجموعات، مقسّمة إلى مجلدات تعكس بنية واجهتك (auth/ وusers/ وbilling/). ويحتفظ السجل بكل ما أرسلته، مع إخفاء قيم عناوين URL التي تبدو كبيانات اعتماد. وتصبح الطلبات المحفوظة وثائق حية لمن ينضم إلى المشروع بعدك.

4. اختبر مسارات الفشل، لا `200 OK` فقط

استجابة 200 بجسم خاطئ تبقى خطأً. لكل نقطة نهاية تلمسها، افحص:

  • الشكل: هل الحقول موجودة، وبالأنواع المتوقعة، ومسمّاة باتساق؟
  • المدخلات الخاطئة: يجب أن يُرجع غياب حقل مطلوب أو حقل بنوع خاطئ رمز 4xx واضحًا، لا 500 مع تتبّع للمكدس.
  • المصادقة: رمز منتهي الصلاحية أو مفقود. يوقّع JWT Decoder & Signer رمز اختبار بقيمة exp في الماضي.
  • الموارد غير الموجودة: 404 برسالة مفيدة.
  • الترويسات: Content-Type، وترويسات التخزين المؤقت، وترويسات CORS إن كان المتصفح سيستدعيها (يشرح CORS Builder & Debugger أخطاء CORS).
  • الوقت: نقطة النهاية التي تستغرق 900 مللي ثانية محليًا لن تكون أسرع في الإنتاج.

وحين تفحص الحقل نفسه للمرة الثالثة، حوّله إلى تأكيد يعمل مع كل إرسال، أو سلسِل الطلبات (تسجيل الدخول ← الإنشاء ← التحقق)، أو شغّل دفعة لترى نسب زمن الاستجابة المئوية. تُدفع هذه الأدوات المتقدمة بالنقاط التي تكسبها باستخدام الإضافة؛ لا يوجد ما تشتريه.

5. حوّل الطلب إلى شيفرة وأنواع

حين ينجح الطلب، ولّد الشيفرة الخاصة به بـ JavaScript ‏(fetch أو Axios) أو Python أو Go أو Java أو C#‎، أو صدّره بصيغة cURL لملف README أو تقرير خطأ. وللحصول على أنواع من الاستجابة، افتح JSON to Types من الشريط الجانبي Tools: ‏TypeScript أو Zod أو Pydantic أو Kotlin أو Swift أو Dart أو Java أو Go أو JSON Schema.

تعمل انطلاقًا من مواصفات؟ يفحصها OpenAPI / Swagger Toolkit، ويعرض كل نقطة نهاية، ويولّد أنواع TypeScript وعميل fetch وأوامر cURL.

6. افحص قاعدة البيانات والأمان قبل الإصدار

الخلاصة

الخطوةلماذا تهم
البيئاتطلب واحد وخوادم كثيرة؛ ولا أسرار في الطلبات المحفوظة
المجموعاتفحوصات قابلة للتكرار ومعرفة مشتركة
مسارات الفشلتلتقط أخطاء العقود ومعالجة الأخطاء
الشيفرة والأنواعلا نسخ يدوي لعناوين URL وJSON
فحص الأمانإصلاح الترويسات سيئة الإعداد رخيص قبل الإصدار

جرّبه في محررك

مجاني، دون حساب، ويعمل محليًا. لـ VS Code 1.93 أو أحدث وبيئات JetBrains على Windows أو macOS أو Linux.

code --install-extension sayaib.hue-console