API gateway patterns in Rest API - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the primary role of an API Gateway in system design?

An API Gateway acts as a single entry point for clients to access multiple backend services. It handles request routing, composition, and protocol translation, simplifying client interactions.

intermediate

Explain the 'Backend for Frontend' (BFF) pattern.

The BFF pattern creates separate API gateways tailored for different client types (like web, mobile). Each gateway provides a customized API optimized for its client, improving performance and user experience.

intermediate

What is the 'Aggregator' pattern in API gateways?

The Aggregator pattern combines responses from multiple backend services into a single response for the client. This reduces the number of client requests and simplifies client logic.

beginner

How does the API Gateway pattern improve security?

API Gateways centralize security by enforcing authentication, authorization, and rate limiting. This protects backend services and reduces duplicated security logic across services.

advanced

What are some challenges when using an API Gateway?

Challenges include creating a single point of failure, increased latency if not optimized, and complexity in managing the gateway itself. Proper design and scaling strategies are needed to address these.

What pattern involves creating separate API gateways for different client types?

A Proxy

B Aggregator

C Backend for Frontend (BFF)

D Circuit Breaker

The Backend for Frontend (BFF) pattern creates tailored gateways for each client type.

Which API gateway pattern combines multiple backend responses into one?

A Aggregator

B Proxy

C Backend for Frontend

D Rate Limiter

The Aggregator pattern merges responses from multiple services into a single response.

How does an API Gateway improve security?

A By enforcing authentication and rate limiting centrally

B By decentralizing authentication

C By removing all security checks

D By exposing backend services directly

API Gateways centralize security controls like authentication and rate limiting.

What is a potential risk of using an API Gateway?

A It reduces latency to zero

B It eliminates the need for backend services

C It removes the need for client requests

D It can become a single point of failure

An API Gateway can be a single point of failure if not properly managed.

Which of the following is NOT a typical responsibility of an API Gateway?

A Request routing

B Data storage

C Protocol translation

D Request aggregation

API Gateways do not store data; they route and manage requests.

Describe the main patterns used in API gateways and their purposes.

Think about how API gateways tailor responses and combine backend data.

What are the benefits and challenges of using an API Gateway in a microservices architecture?

Consider both advantages and risks of centralizing API management.

Practice

1. What is the primary role of an API Gateway in a microservices architecture?

easy

A. To act as a single entry point that routes client requests to multiple backend services

B. To store data persistently for backend services

C. To replace all backend services with a monolithic service

D. To serve as a database query optimizer

Solution

1. Step 1: Understand the role of API Gateway

   An API Gateway acts as a single entry point for clients to access multiple backend services, simplifying client communication.

2. Step 2: Eliminate incorrect options

   Options A, C, and D describe roles unrelated to API Gateway functions like data storage or replacing services.

3. Final Answer:

   To act as a single entry point that routes client requests to multiple backend services -> Option A

4. Quick Check:

   API Gateway = Single entry point routing [OK]

Hint: API Gateway = single access point for many services [OK]

Common Mistakes:

• Confusing API Gateway with database or storage
• Thinking API Gateway replaces backend services
• Assuming API Gateway only handles security

2. Which of the following is the correct way to configure an API Gateway to route requests to a backend service named user-service?

easy

A. "/users": "user-service/api/v1/users"

B. "/users": "http://user-service/api/v1/users"

C. "users": "http://user-service/api/v1/users"

D. "/users": "http://user-service/api/v1"

Solution

1. Step 1: Check URL path and protocol

   The route key should start with a slash and the backend URL must include the protocol (http://) and full path.

2. Step 2: Validate each option

   "/users": "http://user-service/api/v1/users" correctly uses "/users" as route and full URL with protocol and path. "/users": "user-service/api/v1/users" misses protocol. "users": "http://user-service/api/v1/users" misses leading slash in route. "/users": "http://user-service/api/v1" misses the full path to users.

3. Final Answer:

   "/users": "http://user-service/api/v1/users" -> Option B

4. Quick Check:

   Route starts with / and URL includes http:// [OK]

Hint: Routes start with / and backend URLs need protocol [OK]

Common Mistakes:

• Omitting http:// in backend URL
• Missing leading slash in route path
• Using incomplete backend service path

3. Given the following API Gateway configuration snippet, what will be the response path for a client request to /orders/123?

{
  "/orders": "http://order-service/api/v2/orders"
}

medium

A. http://order-service/api/v2/orders/orders/123

B. http://order-service/api/v2/orders

C. http://order-service/orders/123

D. http://order-service/api/v2/orders/123

Solution

1. Step 1: Understand path forwarding in API Gateway

   The gateway appends the path after the route key to the backend URL. Here, "/orders" is the route key, so "/123" is appended.

2. Step 2: Construct the full backend URL

   Appending "/123" to "http://order-service/api/v2/orders" results in "http://order-service/api/v2/orders/123".

3. Final Answer:

   http://order-service/api/v2/orders/123 -> Option D

4. Quick Check:

   Request path appended after route key URL [OK]

Hint: API Gateway appends extra path after route key URL [OK]

Common Mistakes:

• Not appending the extra path segment
• Duplicating the route key in backend URL
• Ignoring the original request path

4. An API Gateway is configured with the following routes:

{
  "/products": "http://product-service/api/products",
  "/products/details": "http://product-details-service/api/details"
}

A client request to /products/details/456 returns a 404 error. What is the likely cause?

medium

A. The more specific route "/products/details" is shadowed by the generic "/products" route

B. The backend URL for "/products/details" is missing the protocol

C. API Gateway does not support nested routes

D. The client request path is malformed

Solution

1. Step 1: Analyze route matching order

   API Gateways usually match routes in order or by specificity. If the generic "/products" route is matched first, it will forward requests to product-service, ignoring the more specific route.

2. Step 2: Understand 404 cause

   The product-service likely does not handle "/details/456", causing 404. The specific route is shadowed and never reached.

3. Final Answer:

   The more specific route "/products/details" is shadowed by the generic "/products" route -> Option A

4. Quick Check:

   Route specificity matters to avoid shadowing [OK]

Hint: Specific routes must be checked before generic ones [OK]

Common Mistakes:

• Ignoring route matching priority
• Assuming API Gateway can't handle nested routes
• Blaming client request format without checking routes

5. You need to design an API Gateway pattern that aggregates data from user-service and order-service to provide a single response for a client request to /user-orders/{userId}. Which pattern best fits this requirement?

hard

A. Rate limiting pattern to restrict client requests

B. Simple proxy pattern forwarding requests directly to one service

C. Backend for Frontend (BFF) pattern to combine multiple service responses

D. Circuit breaker pattern to handle service failures

Solution

1. Step 1: Identify the need for data aggregation

   The client wants combined data from two services in one response, which requires aggregation logic.

2. Step 2: Match pattern to requirement

   The Backend for Frontend (BFF) pattern is designed to aggregate and tailor responses for specific client needs by calling multiple backend services.

3. Final Answer:

   Backend for Frontend (BFF) pattern to combine multiple service responses -> Option C

4. Quick Check:

   Data aggregation needs BFF pattern [OK]

Hint: Aggregate multiple services with Backend for Frontend pattern [OK]

Common Mistakes:

• Choosing simple proxy which doesn't aggregate
• Confusing rate limiting with aggregation
• Using circuit breaker which handles failures, not aggregation