Why API design affects system usability in HLD - Test Your Understanding

Practice - 5 Tasks

1fill in blank

easy

Complete the code to define a REST API endpoint that returns user data.

HLD

GET /users/[1]

Drag options to blanks, or click blank then click option'

Alist

Bprofile

Cdelete

Dupdate

Attempts:

3 left

💡 Hint

Common Mistakes

Using verbs like 'delete' or 'update' in a GET request endpoint.

The endpoint /users/profile is commonly used to fetch user data, making the API intuitive and usable.

2fill in blank

medium

Complete the code to specify the HTTP method for creating a new resource in REST API.

HLD

HTTP Method: [1] /items

Drag options to blanks, or click blank then click option'

APOST

BGET

CDELETE

DPUT

Attempts:

3 left

💡 Hint

Common Mistakes

Confusing POST with GET or DELETE methods.

The POST method is used to create new resources, which is a key part of API usability by following standards.

3fill in blank

hard

Fix the error in the API response format to improve usability.

HLD

{ "status": "success", "data": [1] }

Drag options to blanks, or click blank then click option'

A[{"id":1,"name":"Alice"}]

Bnull

C"user"

Dtrue

Attempts:

3 left

💡 Hint

Common Mistakes

Returning a string or null instead of structured data.

The data field should contain a list of user objects for clarity and consistency in API responses.

4fill in blank

hard

Fill both blanks to create a clear and consistent API error response.

HLD

{ "error_code": [1], "message": "[2]" }

Drag options to blanks, or click blank then click option'

A404

B500

CNot Found

DInternal Server Error

Attempts:

3 left

💡 Hint

Common Mistakes

Mixing error codes and messages that don't correspond.

A 404 error code with message Not Found clearly informs the user about the missing resource, improving usability.

5fill in blank

hard

Fill all three blanks to design an API endpoint with versioning and resource identification.

HLD

"/[1]/v[2]/[3]/{id}"

Drag options to blanks, or click blank then click option'

Aapi

B1

Cusers

Dservice

Attempts:

3 left

💡 Hint

Common Mistakes

Omitting versioning or using unclear resource names.

Using /api/v1/users/{id} clearly shows the API base, version, and resource, which helps usability and maintainability.