Building a Scalable API with Node.js and Express

Creating a robust backend API is essential for modern web applications. This guide covers the fundamentals of building scalable APIs with Node.js and Express.

Setting Up Express

Start by creating a basic Express server:

const express = require('express');
const app = express();

app.use(express.json());

app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});

app.listen(3000, () => {
  console.log('Server running on port 3000');
});

Routing

Organize your routes for better maintainability:

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

router.get('/', getUsers);
router.post('/', createUser);
router.get('/:id', getUserById);

module.exports = router;

// app.js
const userRoutes = require('./routes/users');
app.use('/api/users', userRoutes);

Middleware

Use middleware for cross-cutting concerns:

// Authentication middleware
const authenticate = (req, res, next) => {
  const token = req.header('Authorization');
  if (!token) return res.status(401).json({ error: 'Access denied' });
  // Verify token
  next();
};

app.use('/api/protected', authenticate);

Database Integration

Connect to a database for data persistence:

const mongoose = require('mongoose');

mongoose.connect('mongodb://localhost/myapp', {
  useNewUrlParser: true,
  useUnifiedTopology: true
});

const UserSchema = new mongoose.Schema({
  name: String,
  email: String
});

const User = mongoose.model('User', UserSchema);

Error Handling

Implement proper error handling:

app.use((err, req, res, next) => {
  console.error(err.stack);
  res.status(500).json({ error: 'Something went wrong!' });
});

Conclusion

Building scalable APIs requires careful planning and implementation. By following these patterns, you'll create robust backends that can grow with your application.