0
0
HLDsystem_design~12 mins

API versioning strategies in HLD - Architecture Diagram

Choose your learning style9 modes available
LearnWhyDeepArchPracticeChallengeDesignRecallScale
System Overview - API versioning strategies

This system demonstrates how different API versioning strategies help manage changes in an API without breaking existing clients. It supports multiple API versions simultaneously, ensuring backward compatibility and smooth upgrades.

Architecture Diagram
User
  |
  v
Load Balancer
  |
  v
API Gateway
  |
  +-----------------------------+
  |                             |
  v                             v
Service v1                   Service v2
  |                             |
  v                             v
Database                    Database
  |
  v
Cache
Components
User
client
Sends API requests specifying version
Load Balancer
load_balancer
Distributes incoming requests evenly to API Gateway instances
API Gateway
api_gateway
Routes requests to correct API version based on version info
Service v1
service
Handles API version 1 requests
Service v2
service
Handles API version 2 requests with new features
Database
database
Stores persistent data for all API versions
Cache
cache
Speeds up frequent data retrieval
Request Flow - 11 Hops
User → Load Balancer
Load Balancer → API Gateway
API Gateway → Service v1 or Service v2
Service v1 or Service v2 → Cache
Cache → Service v1 or Service v2
Service v1 or Service v2 → Database
Database → Service v1 or Service v2
Service v1 or Service v2 → Cache
Service v1 or Service v2 → API Gateway
API Gateway → Load Balancer
Load Balancer → User
Failure Scenario
Component Fails:API Gateway
Impact:Requests cannot be routed to correct API version, causing all API calls to fail
Mitigation:Deploy multiple API Gateway instances with health checks and automatic failover to ensure availability
Architecture Quiz - 3 Questions
Test your understanding
Which component decides which API version handles a user request?
ACache
BLoad Balancer
CAPI Gateway
DDatabase
Design Principle
This architecture uses versioned services behind an API Gateway to support multiple API versions simultaneously. It ensures backward compatibility and smooth client upgrades by routing requests based on version info. Caching improves performance, and load balancing ensures availability.