كيفية إنشاء واجهة برمجة تطبيقات REST باستخدام Node.js وExpress

ما هو REST API؟

واجهة برمجة تطبيقات REST هي أسلوب معماري يستخدم بروتوكول HTTP لتسهيل تبادل البيانات بين تطبيقات العميل والخادم. صُممت هذه البنية بناءً على مجموعة من القيود والمبادئ، بما في ذلك واجهة موحدة، واتصالات بدون جنسية، واستخدام أساليب HTTP القياسية (مثل GET وPOST وPUT وDELETE) لإجراء عمليات على الموارد.

مفاهيم واجهة برمجة التطبيقات REST الرئيسية

1. موارد:
   الموارد هي الوحدات الأساسية في REST. يُعرَّف كل مورد بعنوان URL (عنوان فريد). على سبيل المثال، في واجهة برمجة تطبيقات REST لإدارة الكتب، يمكن أن يكون الكتاب موردًا موجودًا في /كتب/1 متاح.
2. طرق HTTP:
   تستخدم واجهات برمجة التطبيقات REST طرق HTTP القياسية للتفاعل مع الموارد:
   • يحصل: استرداد البيانات من الخادم (على سبيل المثال، الحصول على قائمة الكتب أو كتاب معين).
   • بريد: إرسال البيانات إلى الخادم لإنشاء مورد جديد (على سبيل المثال إضافة كتاب جديد).
   • يضع: تحديث مورد موجود ببيانات جديدة (على سبيل المثال، تحديث تفاصيل كتاب موجود).
   • يمسح: حذف مورد من الخادم (على سبيل المثال، حذف كتاب).
3. انعدام الجنسية:
   يجب أن يتضمن كل طلب من العميل إلى الخادم جميع المعلومات التي يحتاجها الخادم لتلبية هذا الطلب. لا يخزّن الخادم أي حالة أو معلومات حول جلسة العميل بين الطلبات. هذه الميزة تجعل واجهات برمجة تطبيقات REST قابلة للتطوير وسهلة الصيانة.
4. التمثيلات:
   يمكن تمثيل الموارد بتنسيقات متنوعة، مثل JSON وXML أو نص عادي. يُعد JSON التنسيق الأكثر شيوعًا نظرًا لخفته وسهولة استخدامه.
5. واجهة موحدة:
   صُممت واجهات برمجة تطبيقات REST لتوفير واجهة موحدة للتفاعل مع الموارد بشكل متسق. ويشمل ذلك:
   • تحديد الموارد: تحدد عناوين URL الموارد بشكل فريد.
   • التعامل مع الموارد من خلال العروض: يستخدم العملاء العروض للتفاعل مع الموارد (على سبيل المثال، إرسال بيانات JSON لإنشاء مورد أو تحديثه).
   • الرسائل التي تصف نفسها: تحتوي كل رسالة على معلومات كافية لوصف كيفية معالجتها.
   • الوسائط المتعددة كمحرك حالة للتطبيق (HATEOAS): يتفاعل العملاء مع الموارد بالكامل من خلال الروابط التشعبية التي يوفرها الخادم بشكل ديناميكي.
6. هندسة العميل والخادم:
   يقوم REST بفصل العميل عن الخادم، مما يسمح لهما بالتطور بشكل مستقل.
7. إمكانية التخزين المؤقت:
   يمكن تحديد الاستجابات من واجهة برمجة تطبيقات REST بشكل صريح على أنها قابلة للتخزين المؤقت أو غير قابلة للتخزين المؤقت. تتيح هذه الميزة للعملاء تخزين الاستجابات مؤقتًا لتحسين الأداء وتقليل الحاجة إلى إرسال طلبات متكررة.

مثال واقعي لواجهة برمجة التطبيقات REST

فيما يلي مثال لنقطة نهاية واجهة برمجة التطبيقات REST لمكتبة:

1. احصل على قائمة بجميع الكتب

عنوان: /الكتب

طريقة HTTP: يحصل

[
{
"id": 1,
"title": "1984",
"author": "George Orwell",
"published_year": 1949
},
{
"id": 2,
"title": "To Kill a Mockingbird",
"author": "Harper Lee",
"published_year": 1960
}
]

2. الحصول على تفاصيل كتاب معين

عنوان: /كتب/{معرف}

طريقة HTTP: يحصل

{
"id": 1,
"title": "1984",
"author": "George Orwell",
"published_year": 1949
}

3. إضافة كتاب جديد

عنوان: /الكتب

طريقة HTTP: بريد

طلب:

POST /books نوع المحتوى: application/json

{
"title": "Brave New World",
"author": "Aldous Huxley",
"published_year": 1932
}

إجابة:

{
"id": 3,
"title": "Brave New World",
"author": "Aldous Huxley",
"published_year": 1932
}

4. تحديث كتاب موجود

عنوان: /كتب/{معرف}

طريقة HTTP: يضع

طلب:

وضع /books/1 نوع المحتوى: application/json

PUT /books/1
Content-Type: application/json
{
"title": "1984",
"author": "George Orwell",
"published_year": 1948
}

إجابة:

{
"id": 1,
"title": "1984",
"author": "George Orwell",
"published_year": 1948
}

ما هو Node.js؟

Node.js هي بيئة تشغيل JavaScript من جانب الخادم، تتكامل مع إطار عمل Express الشهير لجعل بناء واجهات برمجة تطبيقات REST قويًا وفعالًا. في هذه المقالة، سنشرح لك خطوة بخطوة عملية إنشاء واجهة برمجة تطبيقات REST باستخدام Node.js وExpress، مع أمثلة عملية.

لماذا تستخدم Node.js و Express لبناء واجهات برمجة التطبيقات REST؟

1. الأداء العالي وقابلية التوسع: بُني Node.js على مُحرك Google V8، الذي يُترجم JavaScript مباشرةً إلى شيفرة الآلة، مما يُؤدي إلى سرعة وأداء عاليين. يتميز نموذج الإدخال/الإخراج غير الحظري في Node.js بكفاءة عالية في التعامل مع عدد كبير من الاتصالات المتزامنة.
2. جافا سكريبت في كل مكان: يتيح Node.js للمطورين استخدام JavaScript لتطوير العميل والخادم، مما يجعل التعلم أسهل ويبسط عملية التطوير.
3. دورة التطوير السريع: يُمكّن دمج Node.js مع Express من تطوير التطبيقات بسرعة. Express هو إطار عمل بسيط ومرن يوفر مجموعة ميزات قوية لتطبيقات الويب والهواتف المحمولة.
4. نظام بيئي واسع النطاق: تحتوي Node.js على مجموعة غنية من المكتبات والوحدات النمطية عبر npm مما يساعد في التطوير بشكل أسرع.
5. القدرات في الوقت الحقيقي: تتميز Node.js بقدرتها على إنشاء تطبيقات في الوقت الفعلي مثل الدردشة والتحديثات المباشرة.

دليل خطوة بخطوة لبناء واجهة برمجة تطبيقات REST باستخدام Node.js

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

أولاً، قم بإنشاء دليل جديد لمشروعك وقم بتهيئته باستخدام npm:

mkdir my-rest-api
cd my-rest-api
npm init -y

الخطوة 2: تثبيت التبعيات

قم بتثبيت عدة حزم لتشغيل واجهة برمجة التطبيقات REST الخاصة بك:

• يعبر: إطار عمل تطبيقات الويب لـ Node.js.
• محلل الجسم: برنامج وسيط لتحليل نص الطلبات الواردة.
• Nodemon (اختياري): أداة لإعادة تشغيل الخادم تلقائيًا أثناء التطوير.

npm install express body-parser
npm install --save-dev nodemon

الخطوة 3: إنشاء تطبيق Express

إنشاء تطبيق Express وإعداد خادم أساسي:

const express = require('express');
const bodyParser = require('body-parser');
const app = express();
app.use(bodyParser.json());
const port = process.env.PORT || 3000;
app.listen(port, () => {
console.log(`Server is running on port ${port}`);
});

الخطوة 4: تحديد المسارات

تُعرّف المسارات نقاط نهاية واجهة برمجة التطبيقات (API). على سبيل المثال، مسار لطلب GET:

app.get('/api/hello', (req, res) => {
res.json({ message: 'Hello, World!' });
});

الخطوة 5: تنفيذ واجهة برمجة التطبيقات (API)

قم بتشغيل واجهة برمجة التطبيقات الخاصة بك باستخدام Nodemon أو Node.js:

npm start

إذا كان ل http://localhost:3000/api/hello عند الدخول إليه، سوف ترى الرسالة "مرحبا بالعالم!".

الخطوة 6: إضافة المزيد من الطرق

لبناء واجهة برمجة تطبيقات مفيدة، عليك تحديد مسارات إضافية وتنفيذ عمليات CRUD (إنشاء، قراءة، تحديث، حذف) على الموارد. على سبيل المثال، واجهة برمجة تطبيقات بسيطة لقائمة مهام:

let todos = [];
app.get('/api/todos', (req, res) => {
res.json(todos);
});
app.post('/api/todos', (req, res) => {
const newTodo = req.body;
todos.push(newTodo);
res.status(201).json(newTodo);
});
// Implement PUT and DELETE as an exercise

في هذا المثال، تم تعريف مسارات لإدراج المهام الجديدة وإنشائها. يمكنك تنفيذ الطرق التالية: يضع و يمسح قم بتوسيعه لتحديث وحذف المهام.

الخطوة 7: اختبار واجهة برمجة التطبيقات (API)

من المهم جدًا اختبار واجهة برمجة التطبيقات (API) الخاصة بك للتأكد من عملها بشكل صحيح. أدوات مثل ساعي البريد أو أبيدوج يمكنهم مساعدتك في إرسال الطلبات ومراجعة الردود.

الخطوة 8: نشر واجهة برمجة التطبيقات (API)

عندما تكون مستعدًا لمشاركة واجهة برمجة التطبيقات الخاصة بك مع الآخرين، يمكنك نشرها على منصات مثل Heroku أو AWS أو Azure.

طريقة بديلة لإنشاء واجهة برمجة التطبيقات REST باستخدام Apidog

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

الخطوة 1: تنزيل وتثبيت Apidog

أولاً، عليك إنشاء حساب على Apidog. يمكنك القيام بذلك عبر موقع Apidog الإلكتروني والنقر على زر "تسجيل".

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

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

الخطوة 3: تعيين معلمات واجهة برمجة التطبيقات REST

قم بملء طرق HTTP، ونماذج الطلب/الاستجابة، ومعلمات الاستعلام، والرؤوس، وما إلى ذلك.

الخطوة 4: اختبار واجهة برمجة التطبيقات REST

بعد تطوير واجهة برمجة التطبيقات (API)، يمكنك اختبارها بالنقر فوق زر "إرسال".

الأسئلة الشائعة حول واجهة برمجة التطبيقات REST في Node.js

1. ما هو أفضل إطار عمل لـ REST API في Node.js؟

على الرغم من أن Feathers وNest وLoopBack وMoleculer تعد أطر عمل رائعة، إلا أن هناك أسباب تجعل Express الخيار الأفضل:

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

2. هل يجب علينا استخدام Go أو Node.js لـ REST API؟

يعتمد الاختيار بين Go وNode.js على عوامل مختلفة مثل متطلبات الأداء وسرعة التطوير وخبرة فريقك.

عندما يكون Go مناسبًا:

• تحتاج إلى أداء وكفاءة عالية.
• يحتاج تطبيقك إلى إدارة عدد كبير من العمليات المتزامنة.
• تفضل اللغة المكتوبة.

عندما يكون Node.js مناسبًا:

• تحتاج إلى دورة تطوير سريعة.
• يعتمد تطبيقك على الإدخال/الإخراج.
• تستخدم JavaScript طوال المشروع.

3. هل Node.js مناسب لتطوير API؟

نعم، Node.js مناسب جدًا لبناء واجهات برمجة التطبيقات RESTful نظرًا لهندسته المعمارية غير الحظرية وأدواته مثل Express.

4. ما هي أفضل لغة لتنفيذ واجهة برمجة التطبيقات REST؟

تعتمد أفضل لغة لتنفيذ واجهة برمجة التطبيقات REST على الاحتياجات المحددة لمشروعك، وخبرة فريق التطوير لديك، ومجموعة التكنولوجيا الحالية لديك.

• للنمذجة السريعة: بايثون (مع إطار عمل Flask أو Django) أو روبي (مع إطار عمل Rails).
• للحصول على أداء عالي: انتقل إلى C# (مع ASP.NET Core).
• من أجل نظام بيئي قوي ودعم مجتمعي: JavaScript (مع Node.js) أو PHP.
• بالنسبة لتطبيقات مستوى المؤسسة: جافا أو C#.

5. هل يستخدم Node.js واجهة برمجة التطبيقات REST؟

Node.js بحد ذاته بيئة تشغيل JavaScript من جانب الخادم، ولا يحتوي على إمكانيات REST API مدمجة. مع ذلك، بفضل بنيته غير الحظرية ووجود أطر عمل مثل Express.js، يُستخدم Node.js على نطاق واسع لبناء واجهات برمجة تطبيقات REST.

6. هل لا يزال الناس يستخدمون Express؟

نعم، لا يزال Express.js يستخدم على نطاق واسع لتطوير واجهات برمجة التطبيقات REST وتطبيقات الويب.

7. هل Next.js بديل لـ Express؟

Next.js وExpress أداتان تخدمان أغراضًا مختلفة في بيئة تطوير الويب، ولا تُغني إحداهما عن الأخرى. يُستخدم Next.js بشكل أكثر شيوعًا في التصيير من جانب الخادم وبناء تطبيقات React، بينما يُعد Express أكثر ملاءمة لإدارة المسارات وبناء واجهات برمجة تطبيقات RESTful.

8. هل Node.js مناسب لتطوير API؟

نعم، يُعد Node.js مثاليًا لتطوير واجهات برمجة التطبيقات (API) بفضل بنيته غير المحظورة وقدرته على التعامل مع عدد كبير من الاتصالات المتزامنة. كما أنه مع أطر عمل مثل Express.js، يصبح بناء واجهات برمجة تطبيقات RESTful باستخدام Node.js أمرًا سهلًا وسريعًا.

9. ما هي أفضل قاعدة بيانات لواجهات برمجة التطبيقات Node.js؟

تعتمد أفضل قاعدة بيانات لواجهات برمجة التطبيقات Node.js على الاحتياجات المحددة لمشروعك:

• مونغو دي بي: من أجل المرونة والتكامل السهل مع Node.js.
• PostgreSQL و MySQL: للحصول على توافق قوي وإمكانيات SQL.
• SQLite: للتطبيقات البسيطة أو الاستخدامات المضمنة.

إن تقييم احتياجات تطبيقك واختيار قاعدة البيانات المناسبة سيساعدك على ضمان نجاح مشروعك.

نتيجة

يُعدّ بناء واجهة برمجة تطبيقات REST باستخدام Node.js وExpress مهارةً فعّالة لأي مطور ويب. في هذه المقالة، تناولنا الخطوات الرئيسية، بدءًا من إعداد المشروع، مرورًا بتحديد المسارات، وصولًا إلى الاختبار والنشر. تذكّر أن الممارسة هي مفتاح النجاح، لذا لا تتردد في بناء واجهات برمجة التطبيقات الخاصة بك وتجربة ميزات مختلفة. بهذا الأساس، ستكون مستعدًا تمامًا لتطوير تطبيقات ويب قوية وقابلة للتطوير باستخدام واجهات برمجة تطبيقات RESTful.