REST API design for systems in HLD - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does REST stand for in REST API?

REST stands for Representational State Transfer. It is an architectural style for designing networked applications.

beginner

Why should REST APIs use nouns in their endpoint URLs instead of verbs?

REST APIs use nouns to represent resources because HTTP methods (GET, POST, PUT, DELETE) define the action. This keeps URLs simple and consistent.

intermediate

What HTTP method is typically used to update an existing resource in REST API?

The PUT method is typically used to update an existing resource completely, while PATCH is used for partial updates.

beginner

What is the purpose of status codes in REST API responses?

Status codes tell the client if the request was successful or if there was an error, and what type of error occurred. For example, 200 means success, 404 means resource not found.

intermediate

How can REST APIs handle versioning to maintain backward compatibility?

Versioning can be handled by including the version number in the URL path (e.g., /v1/resource) or in request headers. This allows clients to use different API versions without breaking.

Which HTTP method is used to retrieve data from a REST API?

A POST

B PUT

C GET

D DELETE

GET is used to retrieve data without changing the resource.

In REST API design, what should the URL /users/123 represent?

A A list of all users

B A specific user resource with ID 123

C An action to update user 123

D A login endpoint

URLs represent resources, so /users/123 points to the user with ID 123.

What status code indicates that a resource was not found?

A 404

B 201

C 200

D 500

404 means the requested resource does not exist.

Which HTTP method is best for creating a new resource?

A DELETE

B GET

C PUT

D POST

POST is used to create new resources.

How can you version a REST API to avoid breaking existing clients?

A Include version number in URL or headers

B Avoid using HTTP status codes

C Use only POST method

D Change URLs randomly

Including version info in URLs or headers helps maintain backward compatibility.

Explain the key principles of REST API design and why they matter.

Think about how REST APIs organize resources and communicate actions.

Describe how you would design a REST API endpoint for managing books in a library system.

Focus on resource naming and HTTP methods.