Building RESTful APIs with Node.js and Express

Creating robust REST APIs is fundamental to modern web development. This guide covers everything you need to know about building APIs with Node.js and Express.

Project Setup

Start with a clean project structure:

project/
├── src/
│   ├── controllers/
│   ├── middleware/
│   ├── models/
│   ├── routes/
│   └── utils/
├── tests/
└── package.json

Express Router Setup

Organize your routes for better maintainability:

javascript

// routes/users.js
const express = require('express');
const router = express.Router();
const userController = require('../controllers/userController');

router.get('/', userController.getAllUsers);
router.post('/', userController.createUser);
router.get('/:id', userController.getUserById);
router.put('/:id', userController.updateUser);
router.delete('/:id', userController.deleteUser);

module.exports = router;

Error Handling

Implement centralized error handling:

javascript

const errorHandler = (err, req, res, next) => {
  const { statusCode = 500, message } = err;
  
  res.status(statusCode).json({
    success: false,
    error: {
      message,
      ...(process.env.NODE_ENV === 'development' && { stack: err.stack })
    }
  });
};

Validation and Security

Input Validation: Use Joi or express-validator
Authentication: Implement JWT tokens
Rate Limiting: Prevent abuse
CORS: Configure cross-origin requests
Helmet: Security headers

Database Integration

Whether using MongoDB, PostgreSQL, or MySQL, follow these patterns:

Use connection pooling
Implement proper error handling
Create reusable query builders
Use transactions for complex operations

Testing

Write comprehensive tests:

javascript

describe('User API', () => {
  test('GET /api/users should return all users', async () => {
    const response = await request(app).get('/api/users');
    expect(response.status).toBe(200);
    expect(response.body.success).toBe(true);
  });
});

Building solid APIs requires attention to structure, security, and testing. Follow these patterns for maintainable and scalable backend services.