فهم واجهة برمجة التطبيقات الوهمية في جافا سكريبت: دليل المبتدئين

مرحبًا زملائي المطورين! هل سبق لك أن وجدت نفسك في منتصف بناء تطبيق ويب مذهل، فقط لتصطدم بجدار لأنك تنتظر أن يكون واجهة برمجة التطبيقات جاهزة؟ محبط، أليس كذلك؟ حسنًا، هنا تأتي واجهات برمجة التطبيقات الوهمية للإنقاذ، خاصةً عند العمل مع JavaScript. وتخيل ماذا؟ أدوات مثل Apidog تجعل هذه العملية أكثر سلاسة.

لذا، دعونا نغوص في عالم واجهات برمجة التطبيقات الوهمية في JavaScript ونستكشف كيف يمكن أن تعزز عملية التطوير الخاصة بك!

ما هي واجهة برمجة تطبيقات وهمية؟

واجهة برمجة تطبيقات وهمية تُحاكي سلوك واجهة برمجة تطبيقات حقيقية من خلال تقديم استجابات محددة مسبقًا لطلبات معينة. إنها كأنها بديل للواجهة الفعلية، مما يسمح للمطورين بالاستمرار في بناء واختبار تطبيقاتهم دون الحاجة إلى الانتظار لاكتمال الخدمات الخلفية.

لماذا تستخدم واجهات برمجة التطبيقات الوهمية؟

واجهات برمجة التطبيقات الوهمية مفيدة للغاية لعدة أسباب:

1. تسريع التطوير: لم يعد هناك انتظار لمطوري الخلفية. ابدأ بدمج واجهات برمجة التطبيقات بمجرد أن تبدأ في ترميز الواجهة الأمامية.
2. الاختبار: تساعد في اختبار تطبيقك بدقة من خلال توفير استجابات متسقة.
3. العزل: يمكنك عزل تطوير الواجهة الأمامية الخاصة بك عن الخلفية، مما يقلل التبعية.
4. التعاون: يمكن للفرق أن تعمل بالتوازي دون إعاقة بعضها البعض.

كيفية البدء مع واجهات برمجة التطبيقات الوهمية في JavaScript

الآن، دعونا نقوم بتطبيق عملي. إليك كيفية إعداد واجهة برمجة تطبيقات وهمية في JavaScript.

الخطوة 1: إعداد مشروعك

أولاً، قم بإنشاء مشروع JavaScript جديد. إذا كنت تستخدم Node.js، يمكنك البدء بـ:

mkdir mock-api-demo
cd mock-api-demo
npm init -y

قم بتثبيت Express.js، وهو إطار ويب شهير لـ Node.js:

npm install express

الخطوة 2: إنشاء واجهة برمجة التطبيقات الوهمية الخاصة بك

قم بإنشاء ملف باسم server.js في دليل مشروعك. سيحتوي هذا الملف على كود واجهة برمجة التطبيقات الوهمية الخاصة بك.

const express = require('express');
const app = express();
const port = 3000;

app.use(express.json());

app.get('/api/users', (req, res) => {
    res.json([
        { id: 1, name: 'جون دو' },
        { id: 2, name: 'جان سميث' }
    ]);
});

app.listen(port, () => {
    console.log(`خادم واجهة برمجة التطبيقات الوهمية يعمل على http://localhost:${port}`);
});

قم بتشغيل الخادم بـ:

node server.js

الآن لديك واجهة برمجة تطبيقات وهمية تعمل على http://localhost:3000/api/users التي تعيد قائمة بالمستخدمين.

مقدمة إلى Apidog

بينما كتابة واجهات برمجة تطبيقات وهمية خاصة بك أمر رائع، فإن أدوات مثل Apidog تجعل الأمر أسهل وأكثر قوة. Apidog هي أداة شاملة تساعدك على إنشاء وإدارة واختبار واجهات برمجة التطبيقات بكل سهولة.

لماذا تختار Apidog؟

1. واجهة مستخدم سهلة الاستخدام: لا حاجة لكتابة الكود من الصفر. يوفر Apidog واجهة بصرية لتحديد واجهات برمجة التطبيقات الخاصة بك.
2. التعاون: شارك تعريفات واجهات برمجة التطبيقات الخاصة بك مع فريقك بسهولة.
3. الاختبار: أدوات مدمجة لاختبار واجهات برمجة التطبيقات الخاصة بك من داخل الواجهة.
4. التوثيق: توليد وثائق واجهات برمجة التطبيقات تلقائيًا.

الخطوة 1: إنشاء مشروع جديد

يستخدم Apidog المشاريع لإدارة واجهات برمجة التطبيقات. يمكنك إنشاء واجهات برمجة تطبيقات متعددة تحت مشروع واحد. يجب أن تنتمي كل واجهة برمجة تطبيقات إلى مشروع. لإنشاء مشروع جديد، انقر على زر "مشروع جديد" على الجانب الأيمن من واجهة تطبيق Apidog.

الخطوة 2: إنشاء واجهة برمجة تطبيقات جديدة

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

• طريقة الطلب: GET.
• URL: api/user/{id}، حيث {id} هو المعامل الذي يمثل معرف المستخدم.
• نوع الاستجابة: json.
• محتوى الاستجابة:

{
id: number, // معرف المستخدم
name: string, // اسم المستخدم
gender: 1 | 2, // الجنس: 1 للذكور، 2 للإناث
phone: string, // رقم الهاتف
avatar: string, // عنوان صورة الملف الشخصي
}

لإنشاء واجهة جديدة، انتقل إلى الصفحة الرئيسية للمشروع الذي تم إنشاؤه سابقًا وانقر على زر "+" على الجانب الأيسر.

املأ معلومات الواجهة المقابلة واحفظها.

بهذا، تم إنشاء واجهة تفاصيل المستخدم. وفي الوقت نفسه، قام Apidog تلقائيًا بإنشاء واجهة وهمية لنا بناءً على تنسيق ونوع الحقول الاستجابة. انقر على زر "طلب" تحت القسم الوهمي لعرض الاستجابة الوهمية.

لنلقِ نظرة على الاستجابة الوهمية. انقر على زر "طلب" ثم انقر على "إرسال" على الصفحة التي تفتح.

الخطوة 3. ضبط قواعد المطابقة الوهمية

هل لاحظت شيئًا سحريًا؟ قام Apidog بتعيين حقل "name" إلى نوع السلسلة، ومع ذلك فإنه يعيد الأسماء؛ قام بتعيين حقل "phone" إلى نوع السلسلة، ومع ذلك فإنه يعيد أرقام الهواتف؛ قام بتعيين حقل "avatar" إلى نوع السلسلة، ومع ذلك فإنه يعيد عناوين الصور.

السبب هو أن Apidog يدعم ضبط قواعد المطابقة للواجهة الوهمية. يحتوي Apidog على قواعد مدمجة، ويمكن للمستخدمين أيضًا تخصيص قواعدهم الخاصة. يمكن العثور على هذه القواعد في إعدادات المشروع > إعدادات الميزات > إعدادات الوهم.

يمكنك أيضًا تعيين قواعد وهمية مخصصة لكل حقل. انقر على "وهم" بجوار الحقل:

قواعد المطابقة الوهمية في Apidog هي كما يلي:

1. عندما يتوافق حقل مع قاعدة مطابقة، ستعيد الاستجابة قيمة عشوائية تلبي قاعدة الوهم.
2. إذا لم يتوافق حقل مع أي قاعدة مطابقة، ستعيد الاستجابة قيمة عشوائية تلبي نوع بيانات الحقل.

هناك ثلاثة أنواع من قواعد المطابقة:

1. الرموز النمطية: * تطابق صفر أو أكثر من الأحرف، و؟ تطابق أي حرف مفرد. على سبيل المثال، *name يمكن أن تتطابق مع اسم المستخدم، name، وما إلى ذلك.
2. التعبيرات النمطية.
3. التطابق الدقيق.

قواعد الوهم متوافقة تمامًا مع Mock.js، وقد تم تمديد بعض البنية النحوية التي لا يمتلكها Mock.js (مثل أرقام الهواتف المحلية "@phone"). تتضمن قواعد الوهم المستخدمة بشكل شائع:

1. @integer: عدد صحيح. @integer(min, max).
2. @string: سلسلة نصية. @string(length): يحدد طول السلسلة.
3. @regexp(regexp): تعبير نمطي.
4. @url: عنوان URL.

خلال التطوير، قد نواجه سيناريوهات وهمية مرنة ومعقدة، مثل إعادة محتوى مخصص بناءً على معلمات الطلب المختلفة. على سبيل المثال، ارجع معلومات المستخدم العادي عندما يكون معرفه 1، وسجل خطأ عندما يكون المعرف 2. يدعم Apidog أيضًا هذه السيناريوهات، وأولئك المهتمين يمكنهم الاطلاع على الوثائق المتقدمة للوهم.

تقنيات واجهات برمجة التطبيقات الوهمية المتقدمة

استجابات ديناميكية

في بعض الأحيان، تكون الاستجابات الثابتة غير كافية. قد تحتاج إلى أن تعيد واجهة برمجة التطبيقات الوهمية بيانات مختلفة بناءً على الطلب. دعونا نعزز مثالنا السابق.

app.get('/api/users/:id', (req, res) => {
    const users = [
        { id: 1, name: 'جون دو' },
        { id: 2, name: 'جان سميث' }
    ];

    const user = users.find(u => u.id == req.params.id);
    if (user) {
        res.json(user);
    } else {
        res.status(404).send('المستخدم غير موجود');
    }
});

الآن، يمكنك طلب مستخدم معين بناءً على معرفه، وستعيد واجهة برمجة التطبيقات الوهمية المستخدم المقابل أو خطأ 404 إذا لم يتم العثور على المستخدم.

تأخير الاستجابات

لتحاكي تأخير الشبكة، يمكنك إدخال تأخيرات في استجاباتك. قد يكون ذلك مفيدًا لاختبار كيفية تعامل تطبيقك مع الشبكات البطيئة.

app.get('/api/users', (req, res) => {
    setTimeout(() => {
        res.json([
            { id: 1, name: 'جون دو' },
            { id: 2, name: 'جان سميث' }
        ]);
    }, 2000); // تأخير قدره ثانيتين
});

كيفية توليد بيانات وهمية صديقة للمستخدم بكفاءة مع Apidog؟​

• يمكن لـ Apidog توليد قواعد وهمية بناءً على هيكل البيانات ونوع البيانات في تعريف واجهة برمجة التطبيقات.
• يمتلك Apidog وهمًا ذكيًا مدمجًا، يقوم بتوليد قواعد وهمية بناءً على اسم الحقل ونوع بيانات الحقل. على سبيل المثال، إذا كان حقل سلسلة يحتوي على "صورة"، "وقت"، "مدينة"، إلخ... في اسمه، سيولد Apidog عنوان URL أو سلسلة أو اسم وفقًا لحقل.
• استنادًا إلى قواعد الوهم المدمجة، يمكن لـ Apidog التعرف تلقائيًا على الحقول، مثل الصورة، الصورة الرمزية، اسم المستخدم، رقم الهاتف المحمول، عنوان URL، التاريخ، الوقت، الطابع الزمني، البريد الإلكتروني، المحافظة، المدينة، العنوان، و IP، لتوليد بيانات وهمية صديقة للمستخدم.
• بالإضافة إلى قواعد الوهم المدمجة، يمكن للمستخدمين أيضًا تخصيص القواعد لتلبية احتياجات التخصيص المتنوعة. يدعم مطابقة حقل السلسلة باستخدام التعبيرات النمطية أو الرموز النمطية.

فيما يلي مثال على بيانات وهمية تم إنشاؤها بواسطة Apidog دون أي تكوين:

أفضل الممارسات لاستخدام واجهات برمجة التطبيقات الوهمية

1. اجعلها بسيطة: ابدأ بالاستجابات الثابتة البسيطة وأضف التعقيد تدريجيًا حسب الحاجة.
2. وثق واجهات برمجة التطبيقات الخاصة بك: تأكد من معرفة فريقك بنقاط النهاية المتاحة واستجاباتها.
3. تحديثات منتظمة: حافظ على تحديث واجهات برمجة التطبيقات الخاصة بك مع تطور واجهات برمجة التطبيقات الحقيقية.
4. اختبار شامل: استخدم واجهات برمجة التطبيقات الوهمية لاختبار سيناريوهات مختلفة، بما في ذلك حالات الحافة.

حالات الاستخدام في العالم الحقيقي

تطوير الواجهة الأمامية

عند بناء تطبيق واجهة أمامية، يمكنك استخدام واجهات برمجة التطبيقات الوهمية للبدء في العمل على الميزات على الفور، دون الانتظار لاستعداد الخلفية. تساعد هذه الطريقة في التطوير بالتوازي وتسريع العملية العامة.

الاختبار التلقائي

تعتبر واجهات برمجة التطبيقات الوهمية أساسية للاختبار التلقائي. إنها تقدم استجابات متسقة، مما يجعل من السهل كتابة اختبارات موثوقة. يمكن للأدوات مثل Jest و Cypress الانضمام إلى العمل مع واجهات برمجة التطبيقات الوهمية لاختبار مكونات مختلفة وتدفقات العمل.

النمذجة

عند إنشاء نماذج أو إثباتات مفهومية، تتيح لك واجهات برمجة التطبيقات الوهمية إعداد التفاعلات الخلفية اللازمة بسرعة دون استثمار الوقت في بناء خدمات الخلفية الفعلية.

الخاتمة

تعتبر واجهات برمجة التطبيقات الوهمية نقطة تحول للمطورين، حيث توفر وسيلة لتسريع التطوير، وتحسين الاختبار، وتسهيل التعاون الأفضل. مع أدوات مثل Apidog، يصبح إنشاء وإدارة واجهات برمجة التطبيقات الوهمية أمرًا سهلاً، مما يسمح لك بالتركيز على بناء تطبيقات مذهلة.

لذا، في المرة القادمة التي تجد نفسك تنتظر واجهة برمجة التطبيقات، تذكر أن واجهات برمجة التطبيقات الوهمية هي صديقك الأفضل. ولا تنسَ أن تحقق من Apidog لتجربة خالية من المتاعب!

دعوة للعملقم بتنزيل Apidog مجانًا