Modern Backend Development-এর অন্যতম গুরুত্বপূর্ণ concept হলো REST API Development। Frontend Application এবং Backend Server-এর মধ্যে data exchange করার জন্য REST API ব্যাপকভাবে ব্যবহার করা হয়। React.js, Next.js, Mobile Applications এবং বিভিন্ন external services সাধারণত API-এর মাধ্যমে Backend-এর সঙ্গে communicate করে।
Express.js ব্যবহার করে সহজেই REST API তৈরি করা যায়। REST API-এর মাধ্যমে আমরা User Registration, Login, Product Management, Order Processing, Database Operations এবং অন্যান্য Backend functionality implement করতে পারি।
এই tutorial-এ আমরা Express.js REST API Development শুরু থেকে শিখব। What is REST API, HTTP Methods, HTTP Status Codes, JSON Data, CRUD Operations, API Structure, Controller, Model, Routes এবং Postman দিয়ে API Testing পর্যন্ত প্রতিটি বিষয় বাংলা ব্যাখ্যা ও practical code examples সহ আলোচনা করব।
Module 5: REST API Development – Learning Topics
- What is REST API?
- HTTP Methods
- HTTP Status Codes
- JSON Data
- CRUD Operations
- API Structure
- Controller
- Model
- Routes
- API Testing with Postman
1. What is REST API?
REST (Representational State Transfer) হলো একটি architectural style, যা Web Services এবং API design করার জন্য কিছু architectural constraints বা principles নির্ধারণ করে। REST principles অনুসরণ করে তৈরি API-কে REST API বলা হয়।
সহজভাবে বললে, REST API হলো এমন একটি interface, যার মাধ্যমে Client এবং Server HTTP protocol ব্যবহার করে data exchange করতে পারে। Client request পাঠায় এবং Server সেই request process করে JSON format-এ response পাঠাতে পারে।
উদাহরণ হিসেবে, একটি E-commerce application-এ:
- Frontend থেকে Products List retrieve করা।
- নতুন User Registration করা।
- Product Information update করা।
- Order তৈরি করা।
- নির্দিষ্ট User বা Product delete করা।
এই ধরনের operations REST API-এর মাধ্যমে পরিচালনা করা যায়।
How REST API Works
একটি সাধারণ REST API request-response process নিচের ধাপগুলো অনুসরণ করে:
- Client (Browser, React.js অথবা Mobile App) HTTP Request পাঠায়।
- API Server request গ্রহণ করে।
- Server নির্দিষ্ট route এবং controller খুঁজে বের করে।
- Controller প্রয়োজন অনুযায়ী Model বা Database-এর সঙ্গে কাজ করে।
- Server HTTP Status Code এবং JSON Response তৈরি করে।
- Client response গ্রহণ করে প্রয়োজন অনুযায়ী data display করে।
REST API Architecture Example
Frontend Application
|
| HTTP Request
v
Express.js REST API
|
v
Routes
|
v
Controller
|
v
Model
|
v
Database
|
v
JSON Response
|
v
Frontend Application
Example: Simple REST API
const express = require('express');
const app = express();
app.use(express.json());
app.get('/api/users', (req, res) => {
res.json({
success: true,
message: 'Users retrieved successfully',
data: [
{
id: 1,
name: 'Ariful Islam'
},
{
id: 2,
name: 'Rahim Ahmed'
}
]
});
});
app.listen(3000, () => {
console.log('API Server running on port 3000');
});
Test URL:
http://localhost:3000/api/users
Response:
{
"success": true,
"message": "Users retrieved successfully",
"data": [
{
"id": 1,
"name": "Ariful Islam"
},
{
"id": 2,
"name": "Rahim Ahmed"
}
]
}
REST API-এর গুরুত্বপূর্ণ Principles
- Client-Server: Client এবং Server আলাদাভাবে কাজ করে।
- Stateless: প্রতিটি request প্রয়োজনীয় context বহন করে। Server সাধারণত আগের request-এর client session state-এর ওপর নির্ভর করে না।
- Cacheable: Response cache করা যাবে কি না, তা HTTP caching rules অনুযায়ী নির্ধারিত হয়।
- Uniform Interface: Resources access করার জন্য consistent interface ব্যবহার করা হয়।
- Layered System: Client সরাসরি কোন server layer-এর সঙ্গে communicate করছে, তা না-ও জানতে পারে।
2. HTTP Methods
HTTP Methods হলো Client এবং Server-এর মধ্যে request-এর উদ্দেশ্য নির্ধারণ করার পদ্ধতি। REST API-তে প্রতিটি HTTP Method নির্দিষ্ট ধরনের operation বোঝায়।
যেমন, data retrieve করার জন্য GET, নতুন data create করার জন্য POST, resource replace করার জন্য PUT, partial update করার জন্য PATCH এবং resource delete করার জন্য DELETE ব্যবহার করা হয়।
Common HTTP Methods
| HTTP Method | Purpose | Example Endpoint |
|---|---|---|
| GET | Retrieve Data | /api/users |
| POST | Create New Data | /api/users |
| PUT | Replace a Resource | /api/users/1 |
| PATCH | Partially Update Data | /api/users/1 |
| DELETE | Delete a Resource | /api/users/1 |
2.1 GET Method
GET method ব্যবহার করে Server থেকে data retrieve বা read করা হয়। যেমন, সব users অথবা একটি নির্দিষ্ট user-এর information পাওয়া।
app.get('/api/users', (req, res) => {
res.json({
message: 'All users retrieved successfully'
});
});
2.2 POST Method
POST method ব্যবহার করে Server-এ নতুন resource তৈরি করা হয় অথবা data submit করা হয়। যেমন, নতুন user registration বা product creation।
app.post('/api/users', (req, res) => {
res.status(201).json({
message: 'User created successfully'
});
});
2.3 PUT Method
PUT method সাধারণত কোনো existing resource-এর সম্পূর্ণ representation replace করার জন্য ব্যবহার করা হয়।
app.put('/api/users/:id', (req, res) => {
res.json({
message: 'User replaced successfully',
id: req.params.id
});
});
2.4 PATCH Method
PATCH method ব্যবহার করে existing resource-এর নির্দিষ্ট কিছু field update করা হয়। যেমন, শুধু User Name অথবা Email পরিবর্তন করা।
app.patch('/api/users/:id', (req, res) => {
res.json({
message: 'User updated successfully',
id: req.params.id
});
});
2.5 DELETE Method
DELETE method ব্যবহার করে Server থেকে কোনো existing resource delete করা হয়।
app.delete('/api/users/:id', (req, res) => {
res.json({
message: 'User deleted successfully',
id: req.params.id
});
});
HTTP Methods Summary
| Method | Operation | Common Use |
|---|---|---|
| GET | Read | Get Users |
| POST | Create | Register User |
| PUT | Replace | Replace User |
| PATCH | Partial Update | Update User Email |
| DELETE | Delete | Remove User |
Remember: GET এবং DELETE সাধারণত safe বা idempotent-এর মতো HTTP semantics অনুসরণ করে। PUT-ও idempotent। POST সাধারণত idempotent নয় এবং PATCH-এর idempotency implementation-এর ওপর নির্ভর করতে পারে।
3. HTTP Status Codes
HTTP Status Codes হলো Server-এর response-এর সঙ্গে পাঠানো তিন সংখ্যার code, যা client-কে request-এর result সম্পর্কে জানায়। REST API-তে সঠিক Status Code ব্যবহার করা অত্যন্ত গুরুত্বপূর্ণ।
যেমন, request সফল হলে 200 OK, নতুন resource তৈরি হলে 201 Created, invalid request হলে 400 Bad Request এবং resource না পাওয়া গেলে 404 Not Found পাঠানো হয়।
HTTP Status Code Categories
| Category | Code Range | Meaning |
|---|---|---|
| 1xx | 100–199 | Informational |
| 2xx | 200–299 | Success |
| 3xx | 300–399 | Redirection |
| 4xx | 400–499 | Client Error |
| 5xx | 500–599 | Server Error |
Common HTTP Status Codes
| Status Code | Status Message | Purpose |
|---|---|---|
| 200 | OK | Request Successful |
| 201 | Created | Resource Created Successfully |
| 202 | Accepted | Request Accepted for Processing |
| 204 | No Content | Successful Request Without Response Body |
| 400 | Bad Request | Invalid Request Data |
| 401 | Unauthorized | Authentication Required or Failed |
| 403 | Forbidden | Access Not Allowed |
| 404 | Not Found | Resource Not Found |
| 409 | Conflict | Resource Conflict |
| 422 | Unprocessable Content | Request Content Cannot Be Processed |
| 500 | Internal Server Error | Unexpected Server Error |
| 503 | Service Unavailable | Server Temporarily Unavailable |
Example: Using HTTP Status Codes
const express = require('express');
const app = express();
app.use(express.json());
app.post('/api/users', (req, res) => {
const { name, email } = req.body;
if (!name || !email) {
return res.status(400).json({
success: false,
message: 'Name and email are required'
});
}
res.status(201).json({
success: true,
message: 'User created successfully'
});
});
app.listen(3000, () => {
console.log('Server running on port 3000');
});
এখানে required data না থাকলে 400 Bad Request এবং valid data থাকলে 201 Created response পাঠানো হয়েছে।
4. What is JSON Data?
JSON (JavaScript Object Notation) হলো একটি lightweight data-interchange format, যার মাধ্যমে Client এবং Server-এর মধ্যে structured data আদান-প্রদান করা যায়। JSON মানুষের পড়ার জন্য সহজ এবং বিভিন্ন programming languages-এ ব্যবহার করা যায়।
REST API-তে request এবং response data হিসেবে JSON ব্যাপকভাবে ব্যবহার করা হয়।
Example: JSON Object
{
"id": 1,
"name": "Ariful Islam",
"email": "ariful@example.com",
"role": "Developer",
"active": true
}
এখানে:
idহলো Number।nameহলো String।emailহলো String।roleহলো String।activeহলো Boolean।
JSON Data Types
| Data Type | Example |
|---|---|
| String | "Ariful" |
| Number | 100 |
| Boolean | true |
| Array | [1, 2, 3] |
| Object | {"name": "Ariful"} |
| Null | null |
Example: JSON Request Body in Express.js
const express = require('express');
const app = express();
app.use(express.json());
app.post('/api/products', (req, res) => {
const product = req.body;
res.status(201).json({
success: true,
message: 'Product received successfully',
data: product
});
});
app.listen(3000, () => {
console.log('Server running on port 3000');
});
Postman JSON Body:
{
"name": "Laptop",
"price": 75000,
"category": "Electronics"
}
Response:
{
"success": true,
"message": "Product received successfully",
"data": {
"name": "Laptop",
"price": 75000,
"category": "Electronics"
}
}
Important: JSON-এর property names এবং string values double quotation marks দিয়ে লিখতে হয়। JSON-এ JavaScript-এর মতো comment অথবা undefined value ব্যবহার করা যায় না।
5. What are CRUD Operations?
CRUD হলো চারটি basic database operations-এর সংক্ষিপ্ত রূপ। এগুলো হলো Create, Read, Update এবং Delete। প্রায় প্রতিটি Backend Application-এ এই চারটি operation ব্যবহার করা হয়।
CRUD Full Meaning
| CRUD | Meaning | HTTP Method |
|---|---|---|
| Create | New Data Insert | POST |
| Read | Retrieve Data | GET |
| Update | Modify Existing Data | PUT / PATCH |
| Delete | Remove Data | DELETE |
5.1 Create Operation
Create operation ব্যবহার করে Database-এ নতুন record insert করা হয়। REST API-তে সাধারণত POST method ব্যবহার করা হয়।
app.post('/api/users', (req, res) => {
const user = req.body;
res.status(201).json({
message: 'User created successfully',
data: user
});
});
5.2 Read Operation
Read operation ব্যবহার করে Database থেকে existing records retrieve করা হয়। REST API-তে GET method ব্যবহার করা হয়।
app.get('/api/users', (req, res) => {
res.json({
message: 'Users retrieved successfully'
});
});
5.3 Update Operation
Update operation ব্যবহার করে existing record-এর information পরিবর্তন করা হয়। সম্পূর্ণ resource replace করার জন্য PUT এবং নির্দিষ্ট field update করার জন্য PATCH ব্যবহার করা যায়।
app.patch('/api/users/:id', (req, res) => {
const userId = req.params.id;
const updatedData = req.body;
res.json({
message: 'User updated successfully',
userId: userId,
data: updatedData
});
});
5.4 Delete Operation
Delete operation ব্যবহার করে Database থেকে existing record remove করা হয়। REST API-তে DELETE method ব্যবহার করা হয়।
app.delete('/api/users/:id', (req, res) => {
const userId = req.params.id;
res.json({
message: 'User deleted successfully',
userId: userId
});
});
Complete CRUD API Endpoint Summary
| Operation | Method | Endpoint |
|---|---|---|
| Create User | POST | /api/users |
| Get All Users | GET | /api/users |
| Get Single User | GET | /api/users/:id |
| Replace User | PUT | /api/users/:id |
| Update User | PATCH | /api/users/:id |
| Delete User | DELETE | /api/users/:id |
6. REST API Structure
API Structure বলতে একটি Backend Application-এর বিভিন্ন files এবং folders কীভাবে organize করা হয়, সেটিকে বোঝায়। ছোট project-এ সব code একটি file-এ রাখা সম্ভব হলেও বড় application-এর ক্ষেত্রে আলাদা folders এবং modules ব্যবহার করা ভালো।
একটি organized project structure-এর মাধ্যমে Routes, Controllers, Models এবং Middleware আলাদা রাখা যায়। এতে code maintain, debug এবং scale করা সহজ হয়।
Recommended Express.js Project Structure
rest-api-project/
│
├── node_modules/
│
├── src/
│ │
│ ├── config/
│ │ └── db.js
│ │
│ ├── controllers/
│ │ └── userController.js
│ │
│ ├── models/
│ │ └── userModel.js
│ │
│ ├── routes/
│ │ └── userRoutes.js
│ │
│ ├── middleware/
│ │ └── errorHandler.js
│ │
│ └── app.js
│
├── server.js
│
├── package.json
│
└── package-lock.json
Folder and File Responsibilities
| Folder / File | Responsibilities |
|---|---|
| config/ | Application Configuration |
| controllers/ | Request Handling and Business Logic |
| models/ | Data and Database Logic |
| routes/ | API Endpoints and Route Mapping |
| middleware/ | Authentication and Error Handling |
| app.js | Express App Configuration |
| server.js | Start HTTP Server |
এখন আমরা Controller, Model এবং Routes আলাদাভাবে বুঝব।
7. What is a Controller?
Controller হলো Backend Application-এর একটি অংশ, যেখানে incoming HTTP request handle করা হয় এবং প্রয়োজন অনুযায়ী response তৈরি করা হয়। Controller সাধারণত Route থেকে request গ্রহণ করে Model-এর সঙ্গে communicate করে এবং client-কে response পাঠায়।
সহজভাবে বললে, Controller application-এর request handling এবং business logic পরিচালনা করতে সাহায্য করে।
Why Use Controllers?
- Route files পরিষ্কার রাখা যায়।
- Request handling logic আলাদা রাখা যায়।
- Code reuse এবং maintenance সহজ হয়।
- Application-এর structure organized থাকে।
- Testing এবং debugging সহজ হয়।
Example: userController.js
// controllers/userController.js
exports.getUsers = (req, res) => {
res.json({
message: 'All users retrieved successfully'
});
};
exports.createUser = (req, res) => {
const user = req.body;
res.status(201).json({
message: 'User created successfully',
data: user
});
};
exports.getUserById = (req, res) => {
const userId = req.params.id;
res.json({
message: 'User information',
id: userId
});
};
এখানে তিনটি Controller function তৈরি করা হয়েছে:
getUsers()– সব users retrieve করার জন্য।createUser()– নতুন user create করার জন্য।getUserById()– নির্দিষ্ট user retrieve করার জন্য।
8. What is a Model?
Model হলো application-এর data এবং data-related operations পরিচালনা করার একটি অংশ। Model সাধারণত Database-এর সঙ্গে communicate করে এবং data retrieve, create, update ও delete করতে সাহায্য করে।
যেমন, একটি User Model-এর মাধ্যমে user information database-এ save করা, user retrieve করা অথবা user update ও delete করা যায়।
এই Module-এ আমরা database connection ছাড়া একটি simple in-memory Model তৈরি করব। পরবর্তী Database Module-এ PostgreSQL অথবা অন্য database ব্যবহার করে Model তৈরি করা যাবে।
Example: userModel.js
// models/userModel.js
let users = [
{
id: 1,
name: 'Ariful Islam',
email: 'ariful@example.com'
},
{
id: 2,
name: 'Rahim Ahmed',
email: 'rahim@example.com'
}
];
// Get All Users
exports.getAllUsers = () => {
return users;
};
// Get User By ID
exports.getUserById = (id) => {
return users.find(user => user.id === id);
};
// Create User
exports.createUser = (userData) => {
const newUser = {
id: Math.max(0, ...users.map(user => user.id)) + 1,
...userData
};
users.push(newUser);
return newUser;
};
// Update User
exports.updateUser = (id, updateData) => {
const user = users.find(user => user.id === id);
if (!user) {
return null;
}
Object.assign(user, updateData);
return user;
};
// Delete User
exports.deleteUser = (id) => {
const index = users.findIndex(user => user.id === id);
if (index === -1) {
return false;
}
users.splice(index, 1);
return true;
};
Explanation:
getAllUsers()– সব user return করে।getUserById()– ID অনুযায়ী নির্দিষ্ট user return করে।createUser()– নতুন user তৈরি করে।updateUser()– existing user update করে।deleteUser()– নির্দিষ্ট user delete করে।
এটি একটি learning Model। এখানে data JavaScript array-তে রাখা হয়েছে, তাই server restart করলে data reset হবে। Real application-এ Database ব্যবহার করতে হবে।
9. What are API Routes?
Routes হলো API-এর URL এবং HTTP Methods-এর mapping, যার মাধ্যমে নির্ধারণ করা হয় কোন endpoint-এ request আসলে কোন Controller function execute হবে।
Express.js-এ express.Router() ব্যবহার করে আলাদা route files তৈরি করা যায়। এতে application-এর API endpoints organize করা সহজ হয়।
Example: userRoutes.js
// routes/userRoutes.js
const express = require('express');
const router = express.Router();
const userController = require('../controllers/userController');
// GET All Users
router.get('/', userController.getUsers);
// GET Single User
router.get('/:id', userController.getUserById);
// POST Create User
router.post('/', userController.createUser);
module.exports = router;
এখানে:
router.get()দিয়ে GET endpoint তৈরি করা হয়েছে।router.post()দিয়ে POST endpoint তৈরি করা হয়েছে।- Controller functions-এর সঙ্গে routes connect করা হয়েছে।
module.exportsদিয়ে router export করা হয়েছে।
Connect Routes with Express Application
এখন app.js file তৈরি করে user routes application-এর সঙ্গে connect করুন।
// src/app.js
const express = require('express');
const app = express();
const userRoutes = require('./routes/userRoutes');
// Middleware
app.use(express.json());
// API Routes
app.use('/api/users', userRoutes);
// Home Route
app.get('/', (req, res) => {
res.json({
message: 'Welcome to REST API'
});
});
// 404 Handler
app.use((req, res) => {
res.status(404).json({
success: false,
message: 'Route not found'
});
});
module.exports = app;
Create server.js
// server.js
const app = require('./src/app');
const PORT = 3000;
app.listen(PORT, () => {
console.log(`Server running at http://localhost:${PORT}`);
});
এখন project-এর root folder থেকে নিচের command ব্যবহার করে server চালু করুন:
node server.js
Important: উপরের example-এ Routes এবং Controllers connect করা হয়েছে, কিন্তু CRUD-এর সব operations এখনো controller-এর সঙ্গে model-basedভাবে implement করা হয়নি। নিচে আমরা complete CRUD project তৈরি করব।
Complete REST API CRUD Project
এখন আমরা Model, Controller এবং Routes ব্যবহার করে একটি complete beginner-friendly REST API project তৈরি করব। এই project-এ User Create, Read, Update এবং Delete operations implement করা হবে।
Step 1: Project Structure
rest-api-project/
│
├── src/
│ ├── controllers/
│ │ └── userController.js
│ │
│ ├── models/
│ │ └── userModel.js
│ │
│ ├── routes/
│ │ └── userRoutes.js
│ │
│ └── app.js
│
├── server.js
└── package.json
Step 2: Install Express.js
npm init -y
npm install express
Step 3: Create userModel.js
// src/models/userModel.js
let users = [
{
id: 1,
name: 'Ariful Islam',
email: 'ariful@example.com'
},
{
id: 2,
name: 'Rahim Ahmed',
email: 'rahim@example.com'
}
];
// Get All Users
exports.getAllUsers = () => {
return users;
};
// Get Single User
exports.getUserById = (id) => {
return users.find(user => user.id === id);
};
// Create User
exports.createUser = (userData) => {
const newUser = {
id: Math.max(0, ...users.map(user => user.id)) + 1,
name: userData.name,
email: userData.email
};
users.push(newUser);
return newUser;
};
// Update User
exports.updateUser = (id, updateData) => {
const user = users.find(user => user.id === id);
if (!user) {
return null;
}
if (updateData.name !== undefined) {
user.name = updateData.name;
}
if (updateData.email !== undefined) {
user.email = updateData.email;
}
return user;
};
// Delete User
exports.deleteUser = (id) => {
const index = users.findIndex(user => user.id === id);
if (index === -1) {
return false;
}
users.splice(index, 1);
return true;
};
Step 4: Create userController.js
// src/controllers/userController.js
const User = require('../models/userModel');
// GET All Users
exports.getUsers = (req, res) => {
const users = User.getAllUsers();
res.status(200).json({
success: true,
count: users.length,
data: users
});
};
// GET Single User
exports.getUserById = (req, res) => {
const id = Number(req.params.id);
if (!Number.isInteger(id) || id < 1) {
return res.status(400).json({
success: false,
message: 'Invalid user ID'
});
}
const user = User.getUserById(id);
if (!user) {
return res.status(404).json({
success: false,
message: 'User not found'
});
}
res.status(200).json({
success: true,
data: user
});
};
// POST Create User
exports.createUser = (req, res) => {
const { name, email } = req.body;
if (
typeof name !== 'string' ||
!name.trim() ||
typeof email !== 'string' ||
!email.trim()
) {
return res.status(400).json({
success: false,
message: 'Valid name and email are required'
});
}
const newUser = User.createUser({
name: name.trim(),
email: email.trim()
});
res.status(201).json({
success: true,
message: 'User created successfully',
data: newUser
});
};
// PATCH Update User
exports.updateUser = (req, res) => {
const id = Number(req.params.id);
if (!Number.isInteger(id) || id < 1) {
return res.status(400).json({
success: false,
message: 'Invalid user ID'
});
}
const { name, email } = req.body;
if (
(name !== undefined &&
(typeof name !== 'string' || !name.trim())) ||
(email !== undefined &&
(typeof email !== 'string' || !email.trim()))
) {
return res.status(400).json({
success: false,
message: 'Name and email must be valid strings'
});
}
if (name === undefined && email === undefined) {
return res.status(400).json({
success: false,
message: 'At least one field is required'
});
}
const updatedUser = User.updateUser(id, {
...(name !== undefined ? { name: name.trim() } : {}),
...(email !== undefined ? { email: email.trim() } : {})
});
if (!updatedUser) {
return res.status(404).json({
success: false,
message: 'User not found'
});
}
res.status(200).json({
success: true,
message: 'User updated successfully',
data: updatedUser
});
};
// DELETE User
exports.deleteUser = (req, res) => {
const id = Number(req.params.id);
if (!Number.isInteger(id) || id < 1) {
return res.status(400).json({
success: false,
message: 'Invalid user ID'
});
}
const deleted = User.deleteUser(id);
if (!deleted) {
return res.status(404).json({
success: false,
message: 'User not found'
});
}
res.status(200).json({
success: true,
message: 'User deleted successfully'
});
};
Step 5: Create userRoutes.js
// src/routes/userRoutes.js
const express = require('express');
const router = express.Router();
const userController = require('../controllers/userController');
// GET All Users
router.get('/', userController.getUsers);
// GET Single User
router.get('/:id', userController.getUserById);
// POST Create User
router.post('/', userController.createUser);
// PATCH Update User
router.patch('/:id', userController.updateUser);
// DELETE User
router.delete('/:id', userController.deleteUser);
module.exports = router;
Step 6: Create app.js
// src/app.js
const express = require('express');
const app = express();
const userRoutes = require('./routes/userRoutes');
// Middleware
app.use(express.json());
// Home Route
app.get('/', (req, res) => {
res.json({
success: true,
message: 'Welcome to Express.js REST API'
});
});
// User API Routes
app.use('/api/users', userRoutes);
// 404 Handler
app.use((req, res) => {
res.status(404).json({
success: false,
message: 'API endpoint not found'
});
});
module.exports = app;
Step 7: Create server.js
// server.js
const app = require('./src/app');
const PORT = 3000;
app.listen(PORT, () => {
console.log(`Server running at http://localhost:${PORT}`);
});
Step 8: Run the Project
Terminal-এ নিচের command ব্যবহার করুন:
node server.js
Terminal-এ নিচের message দেখতে পাবেন:
Server running at http://localhost:3000
10. API Testing with Postman
Postman হলো একটি popular API development এবং testing tool। এর মাধ্যমে HTTP requests পাঠানো, response দেখা, status codes যাচাই করা এবং API endpoints test করা যায়।
Backend Developer-রা API তৈরি করার পর Postman ব্যবহার করে প্রতিটি endpoint ঠিকভাবে কাজ করছে কি না পরীক্ষা করেন।
Why Use Postman?
- GET, POST, PUT, PATCH এবং DELETE requests পাঠানো যায়।
- JSON request body পাঠানো যায়।
- Response Body এবং Status Code দেখা যায়।
- Request Headers configure করা যায়।
- API endpoints test এবং organize করা যায়।
- Environment variables ব্যবহার করা যায়।
Step 1: Open Postman
Postman application open করুন অথবা Postman Web ব্যবহার করুন। এরপর New HTTP Request তৈরি করুন।
Step 2: Test GET All Users
- Method: GET
- URL:
http://localhost:3000/api/users - Body: Not Required
Example Response:
{
"success": true,
"count": 2,
"data": [
{
"id": 1,
"name": "Ariful Islam",
"email": "ariful@example.com"
},
{
"id": 2,
"name": "Rahim Ahmed",
"email": "rahim@example.com"
}
]
}
Expected Status Code: 200 OK
Step 3: Test GET Single User
- Method: GET
- URL:
http://localhost:3000/api/users/1 - Body: Not Required
Example Response:
{
"success": true,
"data": {
"id": 1,
"name": "Ariful Islam",
"email": "ariful@example.com"
}
}
Expected Status Code: 200 OK
Step 4: Test POST Create User
- Method: POST
- URL:
http://localhost:3000/api/users - Body: Select raw
- Format: JSON
JSON Request Body:
{
"name": "Sakib Hasan",
"email": "sakib@example.com"
}
Example Response:
{
"success": true,
"message": "User created successfully",
"data": {
"id": 3,
"name": "Sakib Hasan",
"email": "sakib@example.com"
}
}
Expected Status Code: 201 Created
Step 5: Test PATCH Update User
- Method: PATCH
- URL:
http://localhost:3000/api/users/1 - Body: Select raw
- Format: JSON
JSON Request Body:
{
"name": "Md Ariful Islam"
}
Example Response:
{
"success": true,
"message": "User updated successfully",
"data": {
"id": 1,
"name": "Md Ariful Islam",
"email": "ariful@example.com"
}
}
Expected Status Code: 200 OK
Step 6: Test DELETE User
- Method: DELETE
- URL:
http://localhost:3000/api/users/1 - Body: Not Required
Example Response:
{
"success": true,
"message": "User deleted successfully"
}
Expected Status Code: 200 OK
Complete API Testing Summary
| Method | Endpoint | Operation | Expected Status |
|---|---|---|---|
| GET | /api/users | Get All Users | 200 |
| GET | /api/users/1 | Get Single User | 200 |
| POST | /api/users | Create User | 201 |
| PATCH | /api/users/1 | Update User | 200 |
| DELETE | /api/users/1 | Delete User | 200 |
Important: প্রতিটি request test করার সময় Postman-এর Status Code এবং Response Body যাচাই করুন। একটি API শুধু response পাঠালেই যথেষ্ট নয়; সঠিক status code এবং expected data-ও return করতে হবে।
Learning Note!
এই project-এ User Model JavaScript array ব্যবহার করে তৈরি করা হয়েছে। এটি real database নয়। Server restart করলে নতুন তৈরি করা data হারিয়ে যাবে। Production REST API-এর জন্য PostgreSQL, MySQL অথবা MongoDB-এর মতো Database ব্যবহার করতে হবে।
Module 5: Practice Tasks
নিজের learning যাচাই করার জন্য নিচের practical tasks সম্পন্ন করুন।
- Express.js দিয়ে একটি REST API project তৈরি করুন।
- GET method ব্যবহার করে All Products API তৈরি করুন।
- POST method ব্যবহার করে নতুন Product তৈরি করুন।
- PUT method ব্যবহার করে একটি সম্পূর্ণ Product replace করুন।
- PATCH method ব্যবহার করে শুধু Product Name update করুন।
- DELETE method ব্যবহার করে Product delete করুন।
- API response-এ সঠিক HTTP Status Codes ব্যবহার করুন।
- JSON format-এ API request এবং response তৈরি করুন।
- Controllers folder তৈরি করে request handling logic আলাদা করুন।
- Models folder তৈরি করে data operations আলাদা করুন।
- Routes folder তৈরি করে API endpoints organize করুন।
- 404 Not Found response implement করুন।
- Postman দিয়ে সব CRUD operations test করুন।
- পরবর্তী পর্যায়ে PostgreSQL অথবা MySQL database connect করুন।
Module 5: Interview Questions & Answers
এই অংশে REST API Development সম্পর্কিত গুরুত্বপূর্ণ Interview Questions এবং Answers বাংলায় দেওয়া হয়েছে।
1. REST API কী?
REST API হলো একটি API design approach, যা REST architectural constraints অনুসরণ করে। এর মাধ্যমে Client এবং Server HTTP protocol ব্যবহার করে resources-এর সঙ্গে communicate করতে পারে।
2. REST-এর পূর্ণরূপ কী?
REST-এর পূর্ণরূপ হলো Representational State Transfer।
3. REST API কেন ব্যবহার করা হয়?
Frontend এবং Backend-এর মধ্যে data exchange, CRUD operations, authentication এবং বিভিন্ন application-এর মধ্যে communication করার জন্য REST API ব্যবহার করা হয়।
4. REST API কীভাবে কাজ করে?
Client একটি HTTP request পাঠায়। Server সেই request গ্রহণ করে, প্রয়োজন অনুযায়ী data process করে এবং HTTP Status Code ও response body-সহ client-কে response পাঠায়।
5. REST API-তে কোন HTTP Methods বেশি ব্যবহার করা হয়?
REST API-তে সাধারণত GET, POST, PUT, PATCH এবং DELETE methods বেশি ব্যবহার করা হয়।
6. GET এবং POST-এর মধ্যে পার্থক্য কী?
GET method ব্যবহার করে server থেকে data retrieve করা হয়। POST method ব্যবহার করে server-এ নতুন resource তৈরি বা data submit করা হয়।
7. PUT এবং PATCH-এর মধ্যে পার্থক্য কী?
PUT সাধারণত একটি resource-এর সম্পূর্ণ representation replace করার জন্য ব্যবহৃত হয়। PATCH ব্যবহার করা হয় resource-এর নির্দিষ্ট কিছু field update করার জন্য।
8. CRUD কী?
CRUD হলো Create, Read, Update এবং Delete-এর সংক্ষিপ্ত রূপ। এগুলো database-এর চারটি basic operations।
9. HTTP Status Code কী?
HTTP Status Code হলো server-এর response-এর সঙ্গে পাঠানো তিন সংখ্যার code, যা client-কে request-এর result সম্পর্কে জানায়।
10. HTTP Status Code 200 এবং 201-এর মধ্যে পার্থক্য কী?
200 OK বোঝায় request সফল হয়েছে। 201 Created বোঝায় request সফলভাবে একটি নতুন resource তৈরি করেছে।
11. HTTP Status Code 400 এবং 404-এর মধ্যে পার্থক্য কী?
400 Bad Request বোঝায় client-এর request invalid বা সঠিকভাবে process করার উপযোগী নয়। 404 Not Found বোঝায় requested resource পাওয়া যায়নি।
12. JSON কী?
JSON-এর পূর্ণরূপ JavaScript Object Notation। এটি একটি lightweight data-interchange format, যা Client এবং Server-এর মধ্যে structured data exchange করতে ব্যবহৃত হয়।
13. REST API-তে JSON কেন ব্যবহার করা হয়?
JSON lightweight, সহজে পড়া যায় এবং বিভিন্ন programming languages support করে। তাই REST API-তে request এবং response data হিসেবে এটি ব্যাপকভাবে ব্যবহার করা হয়।
14. API Endpoint কী?
API Endpoint হলো একটি নির্দিষ্ট URL, যেখানে Client request পাঠিয়ে কোনো resource access বা operation সম্পন্ন করতে পারে। যেমন /api/users একটি API endpoint।
15. Controller কী?
Controller হলো application-এর একটি অংশ, যা incoming request handle করে, প্রয়োজন অনুযায়ী Model-এর সঙ্গে কাজ করে এবং client-কে response পাঠায়।
16. Model কী?
Model হলো application-এর data এবং data-related operations পরিচালনা করার অংশ। এটি সাধারণত Database-এর সঙ্গে communicate করে এবং Create, Read, Update ও Delete operations পরিচালনা করে।
17. Routes কী?
Routes হলো API-এর URL এবং HTTP Methods-এর mapping, যার মাধ্যমে নির্ধারণ করা হয় কোন request-এর জন্য কোন Controller function execute হবে।
18. Controller এবং Model-এর মধ্যে পার্থক্য কী?
Controller request handling এবং application logic পরিচালনা করে। Model data এবং database-related operations পরিচালনা করে।
19. Express.js-এ express.Router() কেন ব্যবহার করা হয়?
express.Router() ব্যবহার করে application-এর routes আলাদা file-এ organize করা যায়। এতে code modular, reusable এবং maintainable হয়।
20. REST API-তে Stateless বলতে কী বোঝায়?
Stateless বলতে বোঝায় Server প্রতিটি request-কে independent হিসেবে process করে। প্রতিটি request-এ প্রয়োজনীয় information থাকতে হয়; আগের request-এর client session state-এর ওপর নির্ভর করা হয় না।
21. Idempotent HTTP Method কী?
কোনো HTTP method-কে idempotent বলা হয় যদি একই request একাধিকবার পাঠালেও server-এর intended effect প্রথম request-এর পর একই থাকে। GET, PUT এবং DELETE সাধারণত idempotent methods।
22. Postman কী?
Postman হলো একটি API development এবং testing tool। এর মাধ্যমে বিভিন্ন HTTP request পাঠানো, JSON body দেওয়া, headers configure করা এবং response ও status code যাচাই করা যায়।
23. API Testing কেন গুরুত্বপূর্ণ?
API Testing-এর মাধ্যমে endpoint সঠিকভাবে কাজ করছে কি না, expected data return করছে কি না, validation ঠিক আছে কি না এবং সঠিক HTTP Status Code পাঠাচ্ছে কি না যাচাই করা যায়।
24. REST API-তে API Versioning কেন ব্যবহার করা হয়?
API Versioning ব্যবহার করে API-এর নতুন version তৈরি করা যায়, যাতে existing clients-এর functionality নষ্ট না করে নতুন features এবং changes introduce করা সম্ভব হয়। যেমন /api/v1/users এবং /api/v2/users।
25. REST API এবং RESTful API-এর মধ্যে পার্থক্য কী?
RESTful API বলতে এমন API বোঝায়, যা REST architectural constraints যথাযথভাবে অনুসরণ করে। REST API শব্দটি অনেক সময় সাধারণভাবে REST-based API বোঝাতেও ব্যবহার করা হয়।
Conclusion
এই Module-এ আমরা Express.js REST API Development-এর গুরুত্বপূর্ণ concepts শিখেছি। আমরা REST API কী, HTTP Methods, HTTP Status Codes, JSON Data, CRUD Operations, API Structure, Controller, Model, Routes এবং Postman দিয়ে API Testing সম্পর্কে বিস্তারিত আলোচনা করেছি।
এই concepts ভালোভাবে বুঝতে পারলে আপনি Express.js ব্যবহার করে organized REST API তৈরি করতে পারবেন। Controller, Model এবং Routes আলাদা করে কাজ করার মাধ্যমে application-এর code আরও structured এবং maintainable রাখা সম্ভব।
পরবর্তী Module-এ আমরা Express.js Database Integration with PostgreSQL শিখব। সেখানে Database কী, PostgreSQL Setup, Database Connection, SQL Queries এবং Express.js-এর সঙ্গে Database CRUD Operations implement করা নিয়ে আলোচনা করব।
Keep Learning, Keep Building!