API Gateway

Дослідите єдину точку входу для API, маршрутизацію, автентифікацію, лімітування та агрегацію запитів.

Що таке API Gateway

API Gateway — це єдина точка входу для клієнтів до набору backend-сервісів.

Замість того щоб клієнт безпосередньо звертався до кожного мікросервісу:

text

Мобільний застосунок ──► User Service
                    ├──► Order Service
                    └──► Catalog Service

запити проходять через gateway:

text

Мобільний застосунок ──► API Gateway ──► User Service
                                      ├──► Order Service
                                      └──► Catalog Service

text

Запит
  │
  ├── Автентифікація
  │
  ├── Лімітування
  │
  ├── Маршрутизація
  │
  ├── Виклик одного або кількох сервісів
  │
  └── Відповідь

text

1. Видалити зовнішній X-User-Id
2. Перевірити Authorization
3. Визначити користувача
4. Додати власний X-User-Id
5. Передати запит сервісу

javascript

const http = require("node:http");

const PORT = 3000;
const USER_SERVICE_URL = "http://localhost:4001";
const ORDER_SERVICE_URL = "http://localhost:4002";

const rateLimit = new Map();
const RATE_LIMIT = 10;
const RATE_WINDOW_MS = 60_000;

function sendJson(response, statusCode, data, headers = {}) {
  response.writeHead(statusCode, {
    "Content-Type": "application/json; charset=utf-8",
    ...headers
  });

  response.end(JSON.stringify(data));
}

function getClientKey(request) {
  return request.socket.remoteAddress || "unknown";
}

function isRateLimited(key) {
  const now = Date.now();
  const current = rateLimit.get(key);

  if (!current || now >= current.resetAt) {
    rateLimit.set(key, {
      count: 1,
      resetAt: now + RATE_WINDOW_MS
    });

    return false;
  }

  if (current.count >= RATE_LIMIT) {
    return true;
  }

  current.count += 1;
  return false;
}

function authenticate(request) {
  const authorization = request.headers.authorization;

  if (authorization !== "Bearer demo-token") {
    return false;
  }

  return true;
}

async function fetchJson(url) {
  const response = await fetch(url);

  if (!response.ok) {
    throw new Error(`Backend service returned ${response.status}`);
  }

  return response.json();
}

function startUserService() {
  const server = http.createServer((request, response) => {
    const url = new URL(request.url, `http://${request.headers.host}`);
    const match = url.pathname.match(/^\/users\/([^/]+)$/);

    if (request.method === "GET" && match) {
      const userId = match[1];

      sendJson(response, 200, {
        id: userId,
        name: "Olena Kovalenko",
        email: "olena@example.com"
      });

      return;
    }

    sendJson(response, 404, { error: "User route not found" });
  });

  server.listen(4001, () => {
    console.log("User Service: http://localhost:4001");
  });
}

function startOrderService() {
  const server = http.createServer((request, response) => {
    const url = new URL(request.url, `http://${request.headers.host}`);

    if (request.method === "GET" && url.pathname === "/orders") {
      const userId = url.searchParams.get("userId");

      sendJson(response, 200, {
        userId,
        orders: [
          { id: "order-101", total: 1250, status: "paid" },
          { id: "order-102", total: 890, status: "shipped" }
        ]
      });

      return;
    }

    sendJson(response, 404, { error: "Order route not found" });
  });

  server.listen(4002, () => {
    console.log("Order Service: http://localhost:4002");
  });
}

async function handleGatewayRequest(request, response) {
  const url = new URL(request.url, `http://${request.headers.host}`);

  if (request.method !== "GET") {
    sendJson(response, 405, { error: "Only GET requests are supported" });
    return;
  }

  const clientKey = getClientKey(request);

  if (isRateLimited(clientKey)) {
    sendJson(
      response,
      429,
      { error: "Too many requests" },
      { "Retry-After": "60" }
    );
    return;
  }

  if (!authenticate(request)) {
    sendJson(response, 401, { error: "Unauthorized" });
    return;
  }

  // Маршрут для отримання одного користувача.
  const userMatch = url.pathname.match(/^\/api\/users\/([^/]+)$/);

  if (userMatch) {
    const userId = userMatch[1];

    try {
      const user = await fetchJson(
        `${USER_SERVICE_URL}/users/${encodeURIComponent(userId)}`
      );

      sendJson(response, 200, user);
    } catch (error) {
      sendJson(response, 502, {
        error: "User Service is unavailable"
      });
    }

    return;
  }

  // Агрегований маршрут викликає два сервіси паралельно.
  const dashboardMatch = url.pathname.match(/^\/api\/dashboard\/([^/]+)$/);

  if (dashboardMatch) {
    const userId = dashboardMatch[1];

    try {
      const [user, orders] = await Promise.all([
        fetchJson(
          `${USER_SERVICE_URL}/users/${encodeURIComponent(userId)}`
        ),
        fetchJson(
          `${ORDER_SERVICE_URL}/orders?userId=${encodeURIComponent(userId)}`
        )
      ]);

      sendJson(response, 200, {
        user,
        orders: orders.orders
      });
    } catch (error) {
      sendJson(response, 502, {
        error: "One of the backend services is unavailable"
      });
    }

    return;
  }

  sendJson(response, 404, { error: "Gateway route not found" });
}

function startGateway() {
  const server = http.createServer((request, response) => {
    handleGatewayRequest(request, response).catch((error) => {
      console.error(error);
      sendJson(response, 500, { error: "Internal server error" });
    });
  });

  server.listen(PORT, () => {
    console.log(`API Gateway: http://localhost:${PORT}`);
    console.log(
      "Приклад запиту: curl -H \"Authorization: Bearer demo-token\" http://localhost:3000/api/dashboard/42"
    );
  });
}

startUserService();
startOrderService();
startGateway();

json

{
  "user": {
    "id": "42",
    "name": "Olena Kovalenko",
    "email": "olena@example.com"
  },
  "orders": [
    {
      "id": "order-101",
      "total": 1250,
      "status": "paid"
    },
    {
      "id": "order-102",
      "total": 890,
      "status": "shipped"
    }
  ]
}

javascript

async function fetchJsonWithTimeout(url) {
  const response = await fetch(url, {
    signal: AbortSignal.timeout(3000)
  });

  if (!response.ok) {
    throw new Error(`Backend returned ${response.status}`);
  }

  return response.json();
}

API Gateway

Що таке API Gateway

Навіщо потрібен gateway

Типовий життєвий цикл запиту

Маршрутизація

Версіювання API

Фіксовані маршрути безпечніші

Автентифікація

Автентифікація та авторизація — різні поняття

Передавання ідентичності користувача

Лімітування запитів

Просте віконне лімітування

Агрегація запитів

Помилки під час агрегації

Мінімальний приклад API Gateway

Тайм-аути та помилки backend-сервісів

Питання продуктивності

Єдина точка входу не повинна стати єдиною точкою відмови

Common mistakes

Передавання довільних URL

Зберігання секретів у клієнтських заголовках

Надмірна бізнес-логіка

Послідовний виклик незалежних сервісів

Відсутність тайм-аутів

Лімітування лише в пам'яті одного процесу

Надмірно детальні помилки

Припущення, що gateway замінює авторизацію

Summary