API Gateway pattern in Microservices - Architecture Diagram

System Overview - API Gateway pattern

The API Gateway pattern is used in microservices to provide a single entry point for clients. It handles requests by routing them to the appropriate microservices, aggregating results, and managing cross-cutting concerns like authentication and rate limiting.

Architecture Diagram

User
  |
  v
Load Balancer
  |
  v
API Gateway
  |        |         |
  v        v         v
Service A  Service B  Service C
  |         |          |
  v         v          v
Database A Database B Database C
  
Cache (shared or per service) connected to each service

Components

User

client

Initiates requests to the system

Load Balancer

load_balancer

Distributes incoming requests evenly to API Gateway instances

API Gateway

api_gateway

Single entry point that routes requests to microservices and handles cross-cutting concerns

Service A

service

Handles specific business logic A

Service B

service

Handles specific business logic B

Service C

service

Handles specific business logic C

Database A

database

Stores data for Service A

Database B

database

Stores data for Service B

Database C

database

Stores data for Service C

Cache

cache

Speeds up data access by storing frequently requested data

Request Flow - 11 Hops

User → Load Balancer

Load Balancer → API Gateway

API Gateway → Cache

Cache → API Gateway

API Gateway → Service A / B / C

Service A / B / C → Database A / B / C

Database A / B / C → Service A / B / C

Service A / B / C → API Gateway

API Gateway → Cache

API Gateway → Load Balancer

Load Balancer → User

Failure Scenario

Component Fails:API Gateway

Impact:All client requests fail because the single entry point is down; no routing to services occurs.

Mitigation:Deploy multiple API Gateway instances behind the load balancer for redundancy and failover.

Architecture Quiz - 3 Questions

What is the main role of the API Gateway in this architecture?

A To store all user data permanently

B To route client requests to the correct microservice and handle cross-cutting concerns

C To balance load between databases

D To cache all data for the system

Design Principle

The API Gateway pattern centralizes request handling, simplifying client interactions and enabling consistent management of security, routing, and caching. It improves scalability by decoupling clients from microservices and allows independent service evolution.

Practice

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

easy

A. It acts as a single entry point to route requests to multiple microservices.

B. It stores all the data for the microservices.

C. It replaces the database in the system.

D. It directly manages the internal logic of each microservice.

Solution

1. Step 1: Understand the role of API Gateway

   An API Gateway serves as a single entry point that routes client requests to the appropriate microservices.

2. Step 2: Eliminate incorrect roles

   It does not store data, replace databases, or manage internal microservice logic; those are handled by other components.

3. Final Answer:

   It acts as a single entry point to route requests to multiple microservices. -> Option A

4. Quick Check:

   API Gateway = Single entry point [OK]

Hint: API Gateway routes requests, it does not store data [OK]

Common Mistakes:

• Confusing API Gateway with database or service logic
• Thinking API Gateway manages microservice internals
• Assuming API Gateway stores data

2. Which of the following is the correct way to describe the API Gateway's function in handling client requests?

easy

A. API Gateway directly executes business logic for each microservice.

B. API Gateway replaces the need for microservices.

C. API Gateway stores client data permanently.

D. API Gateway routes requests, handles authentication, and aggregates responses.

Solution

1. Step 1: Identify API Gateway responsibilities

   API Gateway routes requests, manages security like authentication, and can combine responses from multiple services.

2. Step 2: Remove incorrect options

   It does not execute business logic itself, store data permanently, or replace microservices.

3. Final Answer:

   API Gateway routes requests, handles authentication, and aggregates responses. -> Option D

4. Quick Check:

   Routing + Security + Aggregation = API Gateway [OK]

Hint: API Gateway routes and secures, does not store data [OK]

Common Mistakes:

• Thinking API Gateway runs business logic
• Confusing API Gateway with data storage
• Assuming API Gateway replaces microservices

3. Consider this simplified request flow: A client sends a request to the API Gateway, which then calls Service A and Service B. The API Gateway combines their responses and sends back a single response to the client. What is the main benefit of this approach?

medium

A. It increases the number of client requests to microservices.

B. It reduces the number of client requests by aggregating responses.

C. It forces clients to call each microservice separately.

D. It eliminates the need for microservices.

Solution

1. Step 1: Analyze the request flow

   The API Gateway receives one client request and internally calls multiple services, then combines their responses.

2. Step 2: Understand the benefit

   This reduces the number of requests the client must make, simplifying client logic and improving efficiency.

3. Final Answer:

   It reduces the number of client requests by aggregating responses. -> Option B

4. Quick Check:

   Response aggregation reduces client calls [OK]

Hint: API Gateway aggregates responses to reduce client calls [OK]

Common Mistakes:

• Thinking client must call each service separately
• Believing API Gateway increases client requests
• Confusing aggregation with service removal

4. A developer implemented an API Gateway but notices that clients receive errors when calling multiple microservices through it. Which of the following is the most likely cause?

medium

A. The client is bypassing the API Gateway and calling microservices directly.

B. The microservices do not have any APIs.

C. The API Gateway is not properly routing requests to the correct microservices.

D. The API Gateway is storing all client data incorrectly.

Solution

1. Step 1: Identify the error source

   If clients get errors when calling multiple services via the API Gateway, routing issues are a common cause.

2. Step 2: Exclude other causes

   Microservices usually have APIs; clients bypassing the gateway would not cause errors through it; storing data is not the gateway's role.

3. Final Answer:

   The API Gateway is not properly routing requests to the correct microservices. -> Option C

4. Quick Check:

   Routing errors cause client failures [OK]

Hint: Check routing rules if clients get errors via API Gateway [OK]

Common Mistakes:

• Blaming microservices for missing APIs
• Assuming clients bypass the gateway
• Thinking API Gateway stores client data

5. You are designing a system with multiple microservices and want to use an API Gateway. Which of the following is the best reason to include response aggregation in the API Gateway?

hard

A. To reduce client complexity by combining data from multiple services into one response.

B. To increase the number of network calls clients must make.

C. To allow clients to manage authentication for each microservice separately.

D. To store all microservice data centrally in the API Gateway.

Solution

1. Step 1: Understand response aggregation purpose

   Response aggregation combines data from multiple microservices into a single response, simplifying client handling.

2. Step 2: Evaluate other options

   Increasing network calls or forcing clients to manage authentication per service adds complexity; storing data centrally is not the gateway's role.

3. Final Answer:

   To reduce client complexity by combining data from multiple services into one response. -> Option A

4. Quick Check:

   Aggregation simplifies client responses [OK]

Hint: Aggregate responses to simplify client communication [OK]

Common Mistakes:

• Thinking aggregation increases client calls
• Assuming clients handle all authentications
• Confusing API Gateway with data storage