Resource-based design thinking in Rest API - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Resource-based Design Thinking in REST API?

It is an approach to designing APIs by focusing on resources (things or objects) and their representations, rather than actions or procedures.

beginner

Why do we use nouns instead of verbs in Resource-based Design Thinking?

Because APIs represent resources as nouns (like 'users' or 'orders'), and HTTP methods (GET, POST, PUT, DELETE) define actions on those resources.

beginner

What HTTP method is used to retrieve a resource?

GET is used to retrieve or read a resource without changing it.

intermediate

How does Resource-based Design Thinking improve API usability?

By organizing APIs around resources, it makes them intuitive and predictable, helping developers understand and use them easily.

beginner

What is a resource representation in REST API?

It is the format (like JSON or XML) that shows the current state or data of a resource when sent or received.

In Resource-based Design Thinking, what does a resource usually represent?

A A database query

B A verb representing an action

C A function to execute

D A noun representing an object or thing

Resources are modeled as nouns representing objects or things in REST APIs.

Which HTTP method is typically used to create a new resource?

A POST

B DELETE

C GET

D PUT

POST is used to create new resources in REST APIs.

What does a resource representation usually contain?

A The resource's current data or state

B The server's configuration

C The client's IP address

D The HTTP headers only

A resource representation contains the current data or state of the resource.

Why is Resource-based Design Thinking important for API design?

A It hides all resources from users

B It makes APIs easier to understand and use

C It removes HTTP methods

D It forces all data to be encrypted

Designing APIs around resources makes them intuitive and easier for developers.

Which HTTP method is used to delete a resource?

A PUT

B POST

C DELETE

D GET

DELETE is used to remove a resource in REST APIs.

Explain the main idea behind Resource-based Design Thinking in REST API design.

Think about how APIs represent things and how actions are done on them.

Describe how HTTP methods relate to resources in Resource-based Design Thinking.

Match each HTTP method to what it does with a resource.

Practice

1. What is the main idea behind resource-based design thinking in REST APIs?

easy

A. Focusing only on database tables

B. Using only POST requests for all actions

C. Designing APIs without any structure

D. Organizing APIs around things like users or products

Solution

1. Step 1: Understand the concept of resource-based design

   Resource-based design means APIs are built around resources, which are things like users, products, or orders.

2. Step 2: Compare options to the concept

   Only Organizing APIs around things like users or products correctly describes organizing APIs around things (resources). Other options describe incorrect or unrelated ideas.

3. Final Answer:

   Organizing APIs around things like users or products -> Option D

4. Quick Check:

   Resource-based design = Organizing APIs around resources [OK]

Hint: Think of APIs as managing 'things' like users or products [OK]

Common Mistakes:

• Confusing resource-based design with database design
• Thinking all requests must be POST
• Ignoring the concept of resources

2. Which HTTP method is typically used to update an existing resource in a REST API?

easy

A. PUT

B. POST

C. GET

D. DELETE

Solution

1. Step 1: Recall HTTP methods and their common uses

   GET retrieves data, POST creates new data, PUT updates existing data, DELETE removes data.

2. Step 2: Identify the method for updating

   PUT is the standard method used to update an existing resource in REST APIs.

3. Final Answer:

   PUT -> Option A

4. Quick Check:

   Update resource = PUT [OK]

Hint: PUT means replace or update a resource fully [OK]

Common Mistakes:

• Using POST to update instead of create
• Confusing GET with update
• Using DELETE for updating

3. Given this REST API call: DELETE /products/123, what is the expected result?

medium

A. Retrieve product with ID 123

B. Create a new product with ID 123

C. Delete product with ID 123

D. Update product with ID 123

Solution

1. Step 1: Analyze the HTTP method and URL

   DELETE method means remove. The URL targets the product resource with ID 123.

2. Step 2: Determine the action

   DELETE /products/123 means delete the product with ID 123 from the system.

3. Final Answer:

   Delete product with ID 123 -> Option C

4. Quick Check:

   DELETE + resource ID = delete that resource [OK]

Hint: DELETE + resource ID means remove that resource [OK]

Common Mistakes:

• Thinking DELETE retrieves data
• Confusing DELETE with POST or PUT
• Ignoring the resource ID in URL

4. You see this API request: POST /users/45. What is wrong with this request in resource-based design?

medium

A. The URL should be /users without ID for creating

B. POST cannot be used to create resources

C. The HTTP method should be PUT

D. POST must include a resource ID in the URL

Solution

1. Step 1: Understand POST usage in REST

   POST is used to create new resources. The URL should point to the collection, not a specific resource ID.

2. Step 2: Analyze the request URL

   Including an ID (like /users/45) with POST is incorrect because the server assigns IDs when creating new resources.

3. Final Answer:

   The URL should be /users without ID for creating -> Option A

4. Quick Check:

   POST to collection URL without ID = correct [OK]

Hint: POST creates; URL should be collection without ID [OK]

Common Mistakes:

• Using POST with resource ID in URL
• Thinking POST updates existing resource
• Confusing POST and PUT URLs

5. You want to design an API to manage orders and their items. Which URL and HTTP method combination best follows resource-based design to update the quantity of item 7 in order 42?

hard

A. POST /orders/42/items with item ID and quantity in body

B. PUT /orders/42/items/7 with updated quantity in body

C. DELETE /orders/42/items/7 to update quantity

D. GET /orders/42/items/7 with quantity in query

Solution

1. Step 1: Identify the resource and action

   The resource is the specific item (ID 7) inside order 42. Updating quantity means modifying this resource.

2. Step 2: Choose correct HTTP method and URL

   PUT is used to update existing resources. The URL should point to the specific item resource: /orders/42/items/7.

3. Final Answer:

   PUT /orders/42/items/7 with updated quantity in body -> Option B

4. Quick Check:

   Update nested resource = PUT to specific item URL [OK]

Hint: Use PUT on specific nested resource URL to update it [OK]

Common Mistakes:

• Using POST to update existing item
• Using DELETE to update data
• Using GET with query to change data