Why API design affects system usability in HLD - Architecture Impact

System Overview - Why API design affects system usability

This system explains how the design of an API impacts the ease and efficiency with which developers and users interact with a software system. Key requirements include clear communication, consistent behavior, and fast response times to ensure a positive user experience.

Architecture Diagram

User
  |
  v
Load Balancer
  |
  v
API Gateway
  |
  v
API Service
  |
  +----------------+
  |                |
Cache <---------- Database
  |
  v
Response

Components

User

client

Initiates requests to the system using the API

Load Balancer

load_balancer

Distributes incoming requests evenly to API Gateway instances

API Gateway

api_gateway

Handles routing, authentication, and request validation

API Service

service

Processes API requests, applies business logic, and interacts with data stores

Cache

cache

Stores frequently accessed data to reduce latency and load on the database

Database

database

Stores persistent data for the system

Response

response

Delivers processed data back to the user

Request Flow - 11 Hops

User → Load Balancer

Load Balancer → API Gateway

API Gateway → API Service

API Service → Cache

Cache → API Service

API Service → Database

Database → API Service

API Service → Cache

API Service → API Gateway

API Gateway → Load Balancer

Load Balancer → User

Failure Scenario

Component Fails:API Gateway

Impact:Requests cannot be routed or validated, causing all API calls to fail and users to experience errors.

Mitigation:Deploy multiple API Gateway instances with health checks and automatic failover to ensure availability.

Architecture Quiz - 3 Questions

Which component is responsible for checking if requested data is already stored to reduce database load?

A API Gateway

B Cache

C Load Balancer

D Database

Design Principle

This architecture highlights how good API design, including clear routing, validation, and caching, directly improves system usability by ensuring fast, reliable, and consistent responses to users.

Practice

1. Why is consistent naming important in API design?

easy

A. It hides errors from users.

B. It makes the API run faster.

C. It reduces the size of the API code.

D. It helps developers understand and use the API easily.

Solution

1. Step 1: Understand the role of naming in APIs

   Consistent naming helps developers quickly recognize and remember API functions and parameters.

2. Step 2: Connect naming to usability

   When names are clear and consistent, developers spend less time guessing and more time building.

3. Final Answer:

   It helps developers understand and use the API easily. -> Option D

4. Quick Check:

   Consistent naming = easier API use [OK]

Hint: Good names make APIs easy to learn and use [OK]

Common Mistakes:

• Thinking naming affects speed
• Assuming naming reduces code size
• Believing naming hides errors

2. Which of the following is the correct way to define an API endpoint for getting user details?

easy

A. GET /user/details

B. FETCH userDetails()

C. POST /getUserDetails

D. DELETE /user/details

Solution

1. Step 1: Identify the HTTP method for retrieving data

   GET is the standard HTTP method used to retrieve data without side effects.

2. Step 2: Check the endpoint path format

   /user/details is a clear, RESTful path indicating user details resource.

3. Final Answer:

   GET /user/details -> Option A

4. Quick Check:

   GET method + clear path = correct API endpoint [OK]

Hint: Use GET for fetching data in REST APIs [OK]

Common Mistakes:

• Using POST to fetch data
• Using DELETE for retrieval
• Using non-HTTP syntax like FETCH

3. Consider this API response JSON for a user request:

{"id": 101, "name": "Alice", "email": "[e-mail]"}

What will the client see if the API changes the key email to user_email without updating the client code?

medium

A. The client will show an error or empty email field.

B. The client will show the email correctly.

C. The client will crash immediately.

D. The client will display the email under a different key automatically.

Solution

1. Step 1: Understand client-server data contract

   The client expects the key 'email' to exist in the response to display the email.

2. Step 2: Analyze effect of key name change

   Changing 'email' to 'user_email' breaks the expected key, so the client cannot find the email value.

3. Final Answer:

   The client will show an error or empty email field. -> Option A

4. Quick Check:

   Key name change without client update = missing data [OK]

Hint: Client expects exact keys; changes cause missing data [OK]

Common Mistakes:

• Assuming client auto-updates keys
• Thinking client crashes always
• Believing client shows old key data

4. An API returns error messages as plain text strings. Developers complain it's hard to handle errors. What is the best fix?

medium

A. Return errors as HTML pages.

B. Remove error messages to avoid confusion.

C. Return error messages as structured JSON with error codes.

D. Send errors only in HTTP headers.

Solution

1. Step 1: Identify the problem with plain text errors

   Plain text errors lack structure, making it hard for clients to parse and react programmatically.

2. Step 2: Choose a structured error format

   Structured JSON with error codes allows clients to detect error types and handle them properly.

3. Final Answer:

   Return error messages as structured JSON with error codes. -> Option C

4. Quick Check:

   Structured errors improve client handling [OK]

Hint: Use structured JSON errors for clear client handling [OK]

Common Mistakes:

• Removing errors hides problems
• Using HTML breaks API consistency
• Sending errors only in headers loses detail

5. You are designing an API for a large system used by many developers. Which design choice best improves system usability and scalability?

hard

A. Return all data in one response to reduce calls, ignoring pagination.

B. Use clear, consistent naming with versioning and detailed error messages.

C. Use short, cryptic names to reduce URL length and avoid versioning.

D. Avoid documenting the API to encourage exploration.

Solution

1. Step 1: Consider usability factors

   Clear naming and detailed errors help developers understand and fix issues quickly.

2. Step 2: Consider scalability factors

   Versioning allows safe API evolution; pagination avoids large responses that slow systems.

3. Step 3: Evaluate options

   This option combines best practices for usability and scalability; others harm either or both.

4. Final Answer:

   Use clear, consistent naming with versioning and detailed error messages. -> Option B

5. Quick Check:

   Clear naming + versioning + errors = best API design [OK]

Hint: Combine clarity, versioning, and errors for scalable APIs [OK]

Common Mistakes:

• Choosing cryptic names to save space
• Ignoring pagination causing slow responses
• Skipping documentation hurting usability