ساختن یک API RESTful با Node.js و Express

بررسی اجمالی
ساختن یک API بخش ضروری توسعه برنامه های کاربردی مدرن است. API ها راهی برای برقراری ارتباط برنامه های مختلف با یکدیگر هستند و API های RESTful یک رویکرد محبوب برای ساختن API هایی هستند که انعطاف پذیر، مقیاس پذیر و نگهداری آسان هستند. Node.js و Express.js به دلیل سرعت، انعطاف پذیری و سهولت استفاده، دو مورد از محبوب ترین فناوری هایی هستند که برای ساخت API های RESTful استفاده می شوند.
راه اندازی Node.js و Express.js
قبل از شروع، مطمئن شوید که Node.js و npm روی دستگاه شما نصب شده است. می توانید این موارد را از وب سایت رسمی Node.js (https://nodejs.org) دانلود کنید. سپس یک دایرکتوری جدید برای پروژه خود ایجاد کرده و اجرا کنید npm init
برای ایجاد یک جدید package.json
فایل. این فایل حاوی اطلاعاتی در مورد پروژه شما و وابستگی های آن خواهد بود.
سپس Express.js را با اجرا نصب کنید npm install express
در دایرکتوری پروژه شما با این کار آخرین نسخه Express.js و وابستگی های آن نصب می شود. پس از این، یک فایل جدید به نام ایجاد کنید index.js
و کد زیر را اضافه کنید:
const express = require('express');
const app = express();
const port = 3000;
app.get("https://dev.to/", (req, res) => {
res.send('Hello World!');
});
app.listen(port, () => {
console.log(`Server listening on port ${port}.`);
});
این کد یک سرور اصلی Express.js را راهاندازی میکند که به پورت 3000 گوش میدهد و با “Hello World!” پاسخ میدهد. هنگامی که یک درخواست GET به نقطه پایانی ریشه داده می شود. شما می توانید با اجرای آن تست کنید node index.js
در ترمینال خود فرمان دهید و باز کنید http://localhost:3000
در مرورگر شما
تعریف مسیرها و رسیدگی به درخواست ها
برای تعریف مسیرهای اضافی و رسیدگی به درخواست ها، کد زیر را به آن اضافه کنید index.js
:
app.get('/api/users', (req, res) => {
// Return a list of users
});
app.post('/api/users', (req, res) => {
// Create a new user
});
app.put('/api/users/:id', (req, res) => {
// Update a user by ID
});
app.delete('/api/users/:id', (req, res) => {
// Delete a user by ID
});
این مسیرها درخواستهای GET، POST، PUT و DELETE را به نقطه پایانی /api/users رسیدگی میکنند. پارامتر :id در مسیرهای PUT و DELETE امکان به روز رسانی و حذف کاربران خاص را با شناسه می دهد. میتوانید در صورت نیاز مسیرهای بیشتری را به API خود اضافه کنید و از میانافزار برای انجام احراز هویت، ثبتنام و سایر وظایف استفاده کنید.
اتصال به پایگاه داده
برای ذخیره و بازیابی داده ها برای API خود، باید به یک پایگاه داده متصل شوید. MongoDB یک انتخاب محبوب برای برنامه های Node.js است و Mongoose یک کتابخانه محبوب برای کار با MongoDB است. برای اتصال به پایگاه داده MongoDB با استفاده از Mongoose، کد زیر را به آن اضافه کنید index.js
:
const mongoose = require('mongoose');
mongoose.connect('mongodb://localhost/myapp');
const userSchema = new mongoose.Schema({
name: String,
email: String,
password: String
});
const User = mongoose.model('User', userSchema);
این کد به یک پایگاه داده محلی MongoDB به نام “myapp” متصل می شود و یک طرح و مدل کاربر را با استفاده از Mongoose تعریف می کند. می توانید از مدل User برای ایجاد، خواندن، به روز رسانی و حذف کاربران از پایگاه داده خود استفاده کنید.
نتیجه
Node.js و Express.js یک پلتفرم قدرتمند و انعطاف پذیر برای ساخت API های RESTful ارائه می کنند. با توانایی تعریف مسیرها، رسیدگی به درخواستها و اتصال به پایگاه داده، ساختن یک API مقیاسپذیر و قابل نگهداری آسانتر از همیشه است. با این حال، ساخت یک API قوی نیاز به برنامه ریزی، آزمایش و مستندسازی دقیق دارد. هنگام طراحی API خود باید عواملی مانند امنیت، عملکرد و قابلیت استفاده را در نظر بگیرید و بهترین روشها مانند نسخهسازی، مدیریت خطا و ذخیرهسازی را دنبال کنید. پس برای چی منتظری؟ همین امروز با Node.js و Express.js ساختن API RESTful خود را شروع کنید!