API Gateway Pattern: What It Is and How It Works

The API Gateway pattern is a design approach where a single entry point handles requests to multiple backend services in a microservices system. It acts like a front desk that routes, transforms, and manages requests, simplifying client interactions and improving security and scalability.

How It Works

Imagine a busy hotel lobby where guests ask the front desk for different services like room service, housekeeping, or directions. Instead of guests contacting each department directly, the front desk handles all requests and forwards them to the right team. The API Gateway works the same way in software.

In a microservices system, many small services handle different tasks. The API Gateway is a single point that receives all client requests. It decides which service should handle each request, forwards it, and then sends the response back to the client. It can also add extra features like checking who is making the request (authentication), limiting how many requests come in (rate limiting), or combining responses from multiple services.

Example

This example shows a simple API Gateway using Node.js and Express that forwards requests to two backend services: users and orders.

javascript

import express from 'express';
import fetch from 'node-fetch';

const app = express();
const PORT = 3000;

// Forward user requests
app.use('/users', async (req, res) => {
  const url = `http://localhost:4000${req.originalUrl}`;
  const response = await fetch(url, { method: req.method, headers: req.headers, body: req.method !== 'GET' && req.method !== 'HEAD' ? req : null });
  const data = await response.json();
  res.status(response.status).json(data);
});

// Forward order requests
app.use('/orders', async (req, res) => {
  const url = `http://localhost:5000${req.originalUrl}`;
  const response = await fetch(url, { method: req.method, headers: req.headers, body: req.method !== 'GET' && req.method !== 'HEAD' ? req : null });
  const data = await response.json();
  res.status(response.status).json(data);
});

app.listen(PORT, () => {
  console.log(`API Gateway running on http://localhost:${PORT}`);
});

Output

API Gateway running on http://localhost:3000

When to Use

Use the API Gateway pattern when your system has many microservices and you want to simplify how clients interact with them. It helps by providing a single URL for clients instead of many, making the system easier to use and secure.

Common real-world uses include:

• Mobile apps needing a simple backend interface
• Systems requiring authentication and request control in one place
• Combining data from multiple services into one response

Key Points

• The API Gateway is a single entry point for all client requests.
• It routes requests to the correct microservice.
• It can add security, logging, and response transformation.
• It reduces client complexity by hiding multiple services behind one interface.

Key Takeaways

API Gateway acts as a single front door to multiple microservices.

It simplifies client communication by routing and managing requests.

Use it to add security, rate limiting, and response aggregation.

It improves scalability and maintainability of microservice systems.