ملخص سريع
يتيح لك ملحق Apidog لـ VS Code إرسال طلبات API، وإدارة المجموعات، وتشغيل الاختبارات، ومشاركة مساحات العمل مع فريقك – كل ذلك دون مغادرة محرر الأكواد الخاص بك. يستغرق الإعداد أقل من خمس دقائق: قم بتثبيت الملحق، وسجل الدخول إلى حساب Apidog المجاني الخاص بك، وسيتم تحميل مساحة العمل الخاصة بك مباشرة في الشريط الجانبي لـ VS Code.
مقدمة
بدأ Apidog كتطبيق سطح مكتب لتصميم واجهات برمجة التطبيقات (API) واختبارها وتوثيقها. بمرور الوقت، أصدر الفريق ملحقًا لـ VS Code يجلب نفس مساحة العمل مباشرة إلى محرر الأكواد الخاص بك. لا يكرر الملحق Apidog – بل يتصل بمساحة العمل الحالية الخاصة بك، لذلك تظل المجموعات والبيئات وحالات الاختبار متزامنة سواء كنت تستخدم VS Code أو تطبيق سطح المكتب أو واجهة الويب.
يشرح هذا الدليل سير العمل الكامل: تثبيت الملحق، والاتصال بمساحة عملك، وإرسال الطلبات، وتشغيل الاختبارات، واستخدام ملحق VS Code جنبًا إلى جنب مع تطبيق سطح المكتب.
الخطوة 1: تثبيت ملحق Apidog لـ VS Code
افتح VS Code وانقر على أيقونة الإضافات (Extensions) في الشريط الجانبي الأيسر (أو اضغط Ctrl+Shift+X / Cmd+Shift+X).
ابحث عن "Apidog" في شريط البحث الخاص بمتجر الإضافات (Extensions Marketplace). ابحث عن الملحق الذي نشرته شركة Apidog Inc. – يظهر شعار Apidog (أيقونة داكنة بها أحرف API منمقة).
انقر على "تثبيت" (Install). يقوم VS Code بتثبيت الملحق ويضيف أيقونة Apidog إلى شريط الأنشطة (Activity Bar) الخاص بك على الجانب الأيسر.
بعد التثبيت، انقر على أيقونة Apidog في شريط الأنشطة. يفتح VS Code لوحة Apidog في الشريط الجانبي.
الخطوة 2: تسجيل الدخول إلى حساب Apidog الخاص بك
تعرض لوحة Apidog زر "تسجيل الدخول" (Sign In). انقر عليه.
تفتح علامة تبويب جديدة في المتصفح لصفحة مصادقة Apidog. إذا كان لديك حساب Apidog بالفعل، فأدخل بريدك الإلكتروني وكلمة المرور. إذا لم يكن لديك حساب، فانقر على "اشتراك" (Sign Up) – تتطلب الطبقة المجانية عنوان بريد إلكتروني فقط. لا يلزم وجود بطاقة ائتمان.
بعد تسجيل الدخول، يعرض المتصفح تأكيدًا ويطلب منك العودة إلى VS Code. انقر على "فتح VS Code" (Open VS Code) أو عد إلى VS Code يدويًا.
يكمل VS Code عملية المصادقة ويحمل مساحة عمل Apidog الخاصة بك في الشريط الجانبي.
كيف يبدو الشريط الجانبي بعد تسجيل الدخول: تعرض اللوحة اليسرى عرضًا شجريًا لمساحة عملك. في الأعلى، ترى اسم مساحة عملك. أسفل ذلك، تظهر مجموعاتك كمجلدات. تتوسع كل مجموعة لتظهر الطلبات بداخلها، منظمة حسب هيكل المجلدات. تظهر البيئات في قائمة منسدلة في الجزء العلوي من اللوحة.
الخطوة 3: التنقل في مجموعاتك
يعكس الشريط الجانبي لـ Apidog في VS Code هيكل المجموعة من مساحة عمل Apidog الخاصة بك تمامًا.
لتصفح مجموعة، انقر على السهم بجانب اسم المجموعة. تتوسع المجموعة لتظهر المجلدات والطلبات. تتوسع المجلدات بشكل أكبر إلى طلبات فردية.
يظهر كل طلب كعنصر في قائمة مع شارة ملونة توضح طريقة HTTP (GET باللون الأخضر، POST باللون الأزرق، PUT باللون البرتقالي، DELETE باللون الأحمر). يؤدي النقر على طلب إلى فتحه في منطقة محرر VS Code كعلامة تبويب.
استخدام شريط البحث: في الجزء العلوي من لوحة Apidog، يوجد حقل بحث. اكتب أي كلمة مفتاحية لتصفية مجموعاتك حسب اسم الطلب أو عنوان URL أو الطريقة. هذا مفيد عندما تحتوي مساحة عملك على عشرات المجموعات.
التبديل بين مساحات العمل: إذا كان حساب Apidog الخاص بك ينتمي إلى مساحات عمل متعددة (شخصية، فريق، أو خاصة بمشروع)، يتيح لك محدد مساحة العمل في الجزء العلوي من اللوحة التبديل بينها.
الخطوة 4: إرسال الطلبات
عند فتح طلب من الشريط الجانبي، يتم تحميله في منطقة المحرر الرئيسية كعلامة تبويب. تحتوي واجهة الطلب على تخطيط مألوف:
الشريط العلوي: محدد الطريقة (قائمة منسدلة بها GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS)، حقل URL، وزر إرسال (Send).
علامات التبويب أسفل URL: Params, Headers, Body, Auth, Pre-request Scripts, Tests, Settings. تفتح كل علامة تبويب القسم الخاص بالإعدادات ذات الصلة.
لإرسال طلب:
- تأكيد الطريقة و URL في الشريط العلوي
- إضافة أي رؤوس مطلوبة في علامة تبويب الرؤوس (Headers)
- إذا كان للطلب نص (POST, PUT)، انقر على Body واختر نوع المحتوى (JSON, form data, binary, إلخ.)
- انقر على إرسال (Send)
يظهر الرد في النصف السفلي من علامة التبويب. يعرض رمز الحالة، ووقت الاستجابة، وحجم الاستجابة. تسمح لك علامات التبويب أسفل الاستجابة بعرض النص (مع تمييز بناء الجملة لـ JSON و XML)، والرؤوس، وملفات تعريف الارتباط (cookies)، ونتائج الاختبار.
استخدام البيئات: يحدد محدد البيئة في الجزء العلوي من لوحة Apidog البيئة النشطة. يتم حل المتغيرات مثل {{base_url}} أو {{token}} إلى القيم المحددة في تلك البيئة. قم بتبديل البيئات لتشغيل نفس الطلب مقابل بيئات التطوير (dev) أو الاختبار (staging) أو الإنتاج (production) دون تعديل عناوين URL.
الخطوة 5: تحرير وإنشاء الطلبات
يمكنك تحرير الطلبات الموجودة مباشرة في VS Code. تتم مزامنة التغييرات مع مساحة عمل Apidog الخاصة بك تلقائيًا.
لإنشاء طلب جديد:
- انقر بزر الماوس الأيمن على مجموعة أو مجلد في الشريط الجانبي
- حدد "طلب جديد" (New Request)
- تفتح علامة تبويب طلب فارغة
- عيّن الطريقة (method) وعنوان URL والرؤوس (headers) والنص (body)
- اضغط
Ctrl+S/Cmd+Sللحفظ
يظهر الطلب الجديد في الشريط الجانبي ويمكن الوصول إليه على الفور من تطبيق Apidog لسطح المكتب أو واجهة الويب أو VS Code لأي زميل في الفريق.
إعادة التسمية والتنظيم: انقر بزر الماوس الأيمن على أي طلب أو مجلد في الشريط الجانبي للوصول إلى خيارات إعادة التسمية (rename) والنقل (move) والتكرار (duplicate) والحذف (delete). يعمل إعادة الترتيب بالسحب والإفلات داخل الشريط الجانبي.
الخطوة 6: تشغيل الاختبارات
يدعم Apidog تأكيدات الاختبار التي يتم تشغيلها بعد كل استجابة. في علامة تبويب الاختبارات (Tests) لطلب مفتوح، يمكنك كتابة تأكيدات تعتمد على JavaScript:
pm.test("Status is 200", function () {
pm.response.to.have.status(200);
});
pm.test("Response contains user id", function () {
const json = pm.response.json();
pm.expect(json.id).to.be.a('number');
});
بعد النقر على "إرسال" (Send)، تعرض علامة تبويب الاختبارات (Tests) في قسم الاستجابة التأكيدات التي نجحت وتلك التي فشلت، مع عدد النجاحات/الفشل ورسائل الخطأ للفشل.
تشغيل مجموعة: انقر بزر الماوس الأيمن على مجموعة أو مجلد في الشريط الجانبي وحدد "تشغيل المجموعة" (Run Collection). تفتح لوحة مشغل (runner) حيث يمكنك تعيين التكرارات، والتأخيرات بين الطلبات، والبيئات. انقر على "تشغيل" (Run) لتنفيذ جميع الطلبات بالتسلسل. تعرض النتائج حالة النجاح/الفشل لتأكيدات كل طلب.
الخطوة 7: استخدام ملحق VS Code وتطبيق سطح المكتب معًا
يتشارك ملحق VS Code وتطبيق سطح المكتب نفس مساحة العمل في الوقت الفعلي. لا يوجد إصدار "أساسي" – إنهما عرضان لنفس البيانات.
سير العمل الشائع الذي يستخدم كليهما:
التصميم في سطح المكتب، والاختبار في VS Code: استخدم تطبيق Apidog لسطح المكتب لتحديد مخطط واجهة برمجة التطبيقات (API schema) الخاص بك، وكتابة الوثائق، وإعداد خوادم وهمية (mock servers). ثم انتقل إلى VS Code لتشغيل الطلبات وكتابة تأكيدات الاختبار دون مغادرة بيئة التطوير الخاصة بك.
مراجعة API للفريق: يقوم مطور الواجهة الخلفية (backend) بتحديث نقطة نهاية (endpoint) في تطبيق سطح المكتب. يفتح مطور الواجهة الأمامية (frontend) VS Code مع ملحق Apidog ويرى على الفور الطلب المحدث بالمعلمات الجديدة. لا يوجد طلب سحب (pull request)، ولا ملف JSON للاستيراد.
كتابة الاختبار في السياق: أنت تكتب تعليمات برمجية في VS Code لاستهلاك واجهة برمجة تطبيقات (API). دون التبديل بين النوافذ، يمكنك فتح لوحة Apidog، والعثور على نقطة النهاية ذات الصلة، وتشغيلها، والتحقق من شكل الاستجابة، والعودة إلى التعليمات البرمجية الخاصة بك – مع البقاء في نفس التطبيق طوال الوقت.
ما الذي يفعله تطبيق سطح المكتب بشكل أفضل: تصميم المخطط (Schema design)، وإعداد الخادم الوهمي (mock server setup)، ونشر وثائق واجهة برمجة التطبيقات (API documentation publishing)، وإدارة عدد كبير من البيئات. هذه ميزات مخصصة لتطبيق سطح المكتب أولاً والتي يمكنك الرجوع إليها من VS Code ولكنها أسهل في التكوين في عرض سطح المكتب بملء الشاشة.
الخطوة 8: شارك مع فريقك
إذا كنت تعمل مع مطور أو مطورين آخرين، فأضفهم إلى مساحة عمل Apidog الخاصة بك. من واجهة ويب Apidog أو تطبيق سطح المكتب، انتقل إلى إعدادات مساحة عملك وادعُ أعضاء الفريق عبر البريد الإلكتروني.
بمجرد قبولهم الدعوة وتثبيت ملحق VS Code، يعرض شريطهم الجانبي نفس المجموعات التي تراها. يظهر أي طلب يضيفونه أو يعدلونه للجميع على الفور.
تدعم الطبقة المجانية ما يصل إلى ثلاثة مستخدمين. تتم مزامنة التغييرات عبر سحابة Apidog – لا عمليات Git، ولا تصدير ملفات، ولا تعارضات دمج.
الأسئلة الشائعة
هل يعمل ملحق Apidog لـ VS Code بدون تطبيق سطح المكتب؟نعم. الملحق هو عميل كامل لمساحة عمل Apidog الخاصة بك. لا تحتاج إلى تثبيت تطبيق سطح المكتب لاستخدام الملحق.
هل يمكنني استخدام ملحق Apidog لـ VS Code دون اتصال بالإنترنت؟يمكنك عرض وتعديل المجموعات المخزنة مؤقتًا أثناء عدم الاتصال بالإنترنت. يتطلب إرسال الطلبات إلى واجهات برمجة تطبيقات خارجية اتصالاً بالإنترنت (وكذلك مزامنة التغييرات). يعتمد الدعم الكامل دون اتصال بالإنترنت على حالة ذاكرة التخزين المؤقت لمساحة عمل Apidog الخاصة بك.
كيف أقوم باستيراد مجموعات Thunder Client أو Postman الموجودة؟في تطبيق Apidog لسطح المكتب أو واجهة الويب، انتقل إلى "استيراد" (Import) وحدد التنسيق المناسب (Thunder Client JSON, Postman collection v2.1, OpenAPI، إلخ). تظهر المجموعات المستوردة في مساحة عملك ويمكن الوصول إليها فورًا من ملحق VS Code.
هل ملحق VS Code هو نفسه إنشاء مشروع جديد في Apidog؟لا. يتصل الملحق بمساحة عمل Apidog الحالية الخاصة بك. تقوم بإنشاء وإدارة مساحات العمل من تطبيق سطح المكتب أو واجهة الويب. ملحق VS Code هو عميل يتيح لك العمل ضمن مساحات العمل هذه من داخل VS Code.
هل يمكن لعدة أشخاص فتح نفس المجموعة في نفس الوقت؟نعم. لا يقوم الملحق بقفل المجموعات للتحرير. إذا قام مستخدمان بتحرير نفس الطلب في وقت واحد، فإن الحفظ الأخير هو الذي يفوز. للتحرير المنسق، استخدم ميزات التعاون في تطبيق سطح المكتب.
هل يدعم الملحق الإكمال التلقائي للمتغيرات البيئية؟نعم. عند كتابة {{ في حقل URL أو المعلمات، يقترح الملحق المتغيرات المتاحة من البيئة النشطة. يساعد هذا في تجنب الأخطاء الإملائية في أسماء المتغيرات.
يعمل ملحق Apidog لـ VS Code بشكل أفضل كأداة يومية لك عندما تكون بالفعل تقوم بتطوير واجهات برمجة التطبيقات داخل VS Code. يتكبد إعداد الملحق دقيقتين ولكن العائد يكون سريعًا بمجرد أن تصبح مجموعاتك وبيئاتك ومساحة عمل فريقك كلها متاحة دون الحاجة إلى التبديل بين النوافذ.