Avoiding verbs in URLs in Rest API - Practice Problems & Coding Challenges

Challenge - 5 Problems

❓ Predict Output

intermediate

REST API URL Design: Identify the Correct Resource URL

Which URL best follows REST API principles by avoiding verbs and focusing on resources?

A /users/create

B /createUser

C /users

D /add-user

💡 Hint

Think about URLs as nouns representing resources, not actions.

REST APIs should use nouns in URLs to represent resources. Actions like 'create' or 'add' are verbs and should be avoided in URLs. Instead, HTTP methods (POST, GET, PUT, DELETE) define the action.

🧠 Conceptual

intermediate

Why Avoid Verbs in REST API URLs?

What is the main reason to avoid verbs in REST API URLs?

A Because HTTP methods already specify the action, so URLs should represent resources

B Because verbs make URLs longer and harder to read

C Because verbs cause security issues in APIs

D Because verbs are not supported by all browsers

💡 Hint

Consider how HTTP methods and URLs work together in REST.

In REST, URLs represent resources (nouns), and HTTP methods (GET, POST, PUT, DELETE) specify the action (verb). This separation keeps APIs clean and consistent.

🔧 Debug

advanced

Identify the Problem with This REST API URL

Look at this URL used in a REST API: /deleteOrder/123. What is the main issue with this URL design?

A It uses a verb 'delete' in the URL instead of relying on HTTP DELETE method

B The order ID should be a query parameter, not part of the URL path

C The URL should be uppercase for better readability

D It should use POST method instead of DELETE

💡 Hint

Think about how REST APIs separate actions from resource paths.

REST APIs should avoid verbs in URLs. The action 'delete' should be expressed by the HTTP DELETE method, while the URL should identify the resource, e.g., /orders/123.

📝 Syntax

advanced

Choose the Correct RESTful URL for Updating a User

Which URL correctly follows RESTful design principles for updating a user with ID 45?

A /updateUser/45

B /users/45

C /users/update/45

D /users?id=45&action=update

💡 Hint

Remember, URLs should represent resources, and HTTP methods specify the action.

The URL should identify the resource (/users/45). The update action is indicated by using the HTTP PUT or PATCH method, not by verbs in the URL.

🚀 Application

expert

Design a REST API URL for Filtering Products by Category

You want to design a REST API URL to get products filtered by category 'electronics'. Which URL follows REST principles best?

A /getElectronicsProducts

B /products/electronics

C /filterProducts/category/electronics

D /products?category=electronics

💡 Hint

Think about how to represent filtering in REST APIs using query parameters.

Filtering is best done using query parameters. The URL /products?category=electronics represents the products resource filtered by category without using verbs.

Practice

1. Which of the following URLs follows the best practice of avoiding verbs in REST API design?

easy

A. /createUser

B. /getUser/123

C. /deleteUser/123

D. /users/123

Solution

1. Step 1: Understand URL naming conventions

   REST APIs should use nouns to represent resources, not verbs. URLs like /users/123 represent a user resource with ID 123.

2. Step 2: Identify verbs in URLs

   URLs like /getUser/123, /createUser, and /deleteUser/123 contain verbs (get, create, delete), which is against best practice.

3. Final Answer:

   /users/123 -> Option D

4. Quick Check:

   Use nouns in URLs = /users/123 [OK]

Hint: Use nouns for URLs, verbs go in HTTP methods [OK]

Common Mistakes:

• Including verbs like 'get' or 'delete' in the URL
• Using action words instead of resource names
• Confusing HTTP methods with URL paths

2. Which HTTP method should be used with the URL /orders/456 to update an existing order?

easy

A. PUT

B. POST

C. DELETE

D. GET

Solution

1. Step 1: Match HTTP methods to actions

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

2. Step 2: Identify update action

   To update an existing order at /orders/456, the correct HTTP method is PUT.

3. Final Answer:

   PUT -> Option A

4. Quick Check:

   Update = PUT [OK]

Hint: PUT updates, POST creates, GET reads, DELETE removes [OK]

Common Mistakes:

• Using POST to update instead of create
• Using GET to modify data
• Confusing PUT and DELETE methods

3. Given the REST API call: DELETE /products/789, what is the expected action?

medium

A. Delete product with ID 789

B. Create a new product with ID 789

C. Retrieve product with ID 789

D. Update product with ID 789

Solution

1. Step 1: Understand HTTP DELETE method

   DELETE is used to remove a resource identified by the URL.

2. Step 2: Apply to given URL

   The URL /products/789 identifies product 789, so DELETE removes it.

3. Final Answer:

   Delete product with ID 789 -> Option A

4. Quick Check:

   DELETE removes resource = Delete product with ID 789 [OK]

Hint: DELETE method removes resource at URL [OK]

Common Mistakes:

• Thinking DELETE retrieves data
• Confusing DELETE with POST or PUT
• Assuming URL contains action verbs

4. Identify the error in this REST API design: POST /updateUser/123

medium

A. User ID should not be in the URL

B. HTTP method POST cannot be used with user resources

C. URL contains a verb 'update', which should be avoided

D. URL should end with a question mark

Solution

1. Step 1: Check URL naming conventions

   URLs should use nouns to represent resources, not verbs like 'update'. The verb should be expressed by the HTTP method.

2. Step 2: Analyze the given URL

   The URL /updateUser/123 contains the verb 'update', which violates REST best practices.

3. Final Answer:

   URL contains a verb 'update', which should be avoided -> Option C

4. Quick Check:

   Verbs in URL = URL contains a verb 'update', which should be avoided [OK]

Hint: Avoid verbs in URLs; use HTTP methods for actions [OK]

Common Mistakes:

• Putting verbs like 'update' in URLs
• Misusing HTTP methods
• Ignoring resource identification in URLs

5. You want to design a REST API to manage blog posts. Which URL and HTTP method combination correctly avoids verbs in the URL and uses HTTP methods properly to delete a post with ID 321?

hard

A. DELETE /deletePost/321

B. DELETE /posts/321

C. POST /posts/321/delete

D. GET /posts/delete/321

Solution

1. Step 1: Identify correct URL structure

   The URL should use a noun representing the resource, here /posts/321, without verbs like 'delete'.

2. Step 2: Match HTTP method to action

   To delete a resource, use the DELETE method with the resource URL.

3. Final Answer:

   DELETE /posts/321 -> Option B

4. Quick Check:

   Delete resource = DELETE + noun URL [OK]

Hint: Use DELETE method with noun URL to remove resource [OK]

Common Mistakes:

• Including verbs like 'delete' in the URL
• Using GET or POST for delete actions
• Placing action words after resource ID