Building a REST API
REST principles, CRUD routes, status codes, and input validation
Skills taught: node.rest-principles, node.crud-routes, node.http-status-codes, node.input-validation
A complete CRUD REST API
const express = require('express');
const app = express();
app.use(express.json());
// In-memory store (use a database in production)
let users = [
{ id: 1, name: 'Alice', email: 'alice@example.com', role: 'admin' },
{ id: 2, name: 'Bob', email: 'bob@example.com', role: 'user' },
];
let nextId = 3;
// Validation helper
function validateUser(body) {
const errors = [];
if (!body.name?.trim()) errors.push('name is required');
if (!body.email?.trim()) errors.push('email is required');
if (body.email && !/^[^@]+@[^@]+\.[^@]+$/.test(body.email)) errors.push('email is invalid');
return errors;
}
// GET /users — list all, with optional ?role= filter
app.get('/users', (req, res) => {
const { role } = req.query;
const result = role ? users.filter(u => u.role === role) : users;
res.json({ data: result, meta: { total: result.length } });
});
// GET /users/:id — get one user
app.get('/users/:id', (req, res) => {
const user = users.find(u => u.id === +req.params.id);
if (!user) return res.status(404).json({ error: 'User not found' });
res.json(user);
});
// POST /users — create a user
app.post('/users', (req, res) => {
const errors = validateUser(req.body);
if (errors.length) return res.status(422).json({ errors });
const user = { id: nextId++, ...req.body };
users.push(user);
res.status(201).json(user);
});
// PUT /users/:id — full update
app.put('/users/:id', (req, res) => {
const idx = users.findIndex(u => u.id === +req.params.id);
if (idx === -1) return res.status(404).json({ error: 'User not found' });
const errors = validateUser(req.body);
if (errors.length) return res.status(422).json({ errors });
users[idx] = { id: users[idx].id, ...req.body };
res.json(users[idx]);
});
// DELETE /users/:id — remove a user
app.delete('/users/:id', (req, res) => {
const idx = users.findIndex(u => u.id === +req.params.id);
if (idx === -1) return res.status(404).json({ error: 'User not found' });
users.splice(idx, 1);
res.status(204).end(); // 204 = success, no body
});
app.listen(3000, () => console.log('Users API on :3000'));
Frequently Asked Questions
When should I use PUT vs PATCH?
PUT is a full replacement: the client sends the entire resource and the server replaces it. PATCH is a partial update: the client sends only the fields to change. In practice: use PUT when the client always sends the complete representation; use PATCH for partial edits (like toggling done: true on a todo). PATCH is not guaranteed idempotent (depends on implementation), but PUT always is.