Noun-based resource naming in Rest API - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is noun-based resource naming in REST APIs?

It is a practice of naming API endpoints using nouns that represent resources, such as 'users' or 'products', rather than verbs or actions.

beginner

Why should REST API endpoints use nouns instead of verbs?

Because REST focuses on resources and their state, using nouns makes endpoints clear and consistent, while HTTP methods (GET, POST, etc.) define the actions.

beginner

Example: Which is a better REST API endpoint for retrieving a list of books?
1) /getBooks
2) /books

The better endpoint is /books because it uses a noun representing the resource. The HTTP GET method is used to retrieve the list.

intermediate

How do you name a REST API endpoint for accessing a single resource?

Use the plural noun for the resource followed by its unique identifier, for example, /users/123 to access the user with ID 123.

intermediate

What is the role of HTTP methods in noun-based resource naming?

HTTP methods like GET, POST, PUT, DELETE define the action to perform on the resource named by the noun in the URL.

Which of the following is the best REST API endpoint for retrieving all orders?

A /getOrders

B /orders

C /fetchOrders

D /orders/get

Using the noun 'orders' as the endpoint with the GET method is the correct RESTful approach.

How should you name an endpoint to update a specific product?

A /products/{id}

B /productUpdate

C /products/update/{id}

D /updateProduct

Use the noun 'products' with the product ID and the HTTP PUT method to update the resource.

What HTTP method is typically used with noun-based endpoints to create a new resource?

A GET

B DELETE

C PUT

D POST

POST is used to create a new resource at the noun-based endpoint.

Which URL best follows noun-based resource naming for deleting a user with ID 45?

A /users/delete/45

B /deleteUser/45

C /users/45

D /removeUser?id=45

Use the noun 'users' with the ID and the HTTP DELETE method to delete the resource.

Why avoid verbs in REST API endpoint names?

A Because HTTP methods already define actions

B Because nouns are shorter

C Because verbs are confusing

D Because verbs are deprecated

HTTP methods like GET, POST, PUT, DELETE define the action, so endpoints should use nouns to represent resources.

Explain noun-based resource naming in REST APIs and why it is important.

Think about how REST treats resources and actions separately.

Describe how you would design REST API endpoints for a blog application using noun-based resource naming.

Focus on resources as things you can get or change.

Practice

1. Which of the following is the best example of a noun-based resource name for a REST API endpoint that manages multiple books?

easy

A. /fetchBooks

B. /getBooks

C. /bookAction

D. /books

Solution

1. Step 1: Understand noun-based resource naming

   Noun-based naming uses plural nouns to represent collections of resources, making the API intuitive.

2. Step 2: Identify the correct plural noun path

   Among the options, only '/books' is a plural noun representing the resource collection without verbs or actions.

3. Final Answer:

   /books -> Option D

4. Quick Check:

   Noun-based resource = /books [OK]

Hint: Use plural nouns without verbs for resource paths [OK]

Common Mistakes:

• Including verbs like 'get' or 'fetch' in the URL
• Using singular nouns for collections
• Adding action words in resource names

2. Which of the following is the correct REST API endpoint syntax for accessing a single user resource by ID?

easy

A. /users/get/123

B. /user?id=123

C. /users/123

D. /getUser/123

Solution

1. Step 1: Review REST API syntax for single resource

   Single resources are accessed by appending the resource ID to the plural noun path.

2. Step 2: Identify the correct syntax

   Option '/users/123' correctly uses the plural noun 'users' followed by the ID without verbs or query parameters.

3. Final Answer:

   /users/123 -> Option C

4. Quick Check:

   Single resource path = /users/123 [OK]

Hint: Use /resourceName/{id} for single resource access [OK]

Common Mistakes:

• Adding verbs like 'get' in the path
• Using query parameters instead of path variables
• Using singular noun without ID

3. Given the REST API endpoint GET /orders/456, what does this request represent?

medium

A. Retrieve the order with ID 456

B. Create a new order with ID 456

C. Delete the order with ID 456

D. Update the order with ID 456

Solution

1. Step 1: Understand HTTP GET method

   GET is used to retrieve or read data from the server without modifying it.

2. Step 2: Interpret the endpoint path

   The path '/orders/456' points to a single order resource with ID 456.

3. Final Answer:

   Retrieve the order with ID 456 -> Option A

4. Quick Check:

   GET /orders/456 = Retrieve order 456 [OK]

Hint: GET + /resource/{id} means fetch that resource [OK]

Common Mistakes:

• Confusing GET with POST or DELETE actions
• Assuming the request modifies data
• Misreading the resource ID

4. Identify the error in this REST API endpoint for deleting a user: DELETE /deleteUser/789

medium

A. Missing query parameter for user ID

B. Using a verb 'deleteUser' in the resource path

C. Using DELETE method instead of GET

D. Using plural noun instead of singular

Solution

1. Step 1: Check resource naming conventions

   Resource paths should be nouns, not verbs or actions.

2. Step 2: Analyze the given endpoint

   The path '/deleteUser/789' incorrectly includes the verb 'deleteUser' instead of just '/users/789'.

3. Final Answer:

   Using a verb 'deleteUser' in the resource path -> Option B

4. Quick Check:

   Resource path must be noun, not verb [OK]

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

Common Mistakes:

• Including action verbs in URL paths
• Confusing HTTP method with URL naming
• Using query parameters unnecessarily

5. You want to design a REST API for managing comments on blog posts. Which of the following is the best noun-based resource path to list all comments for a post with ID 42?

hard

A. /posts/42/comments

B. /getCommentsForPost/42

C. /comments?postId=42

D. /postComments/42

Solution

1. Step 1: Understand nested resource naming

   Comments belong to posts, so nesting comments under posts is clear and RESTful.

2. Step 2: Evaluate the options

   Option '/posts/42/comments' uses plural nouns and shows the relationship clearly without verbs or query parameters.

3. Final Answer:

   /posts/42/comments -> Option A

4. Quick Check:

   Nested plural nouns show resource hierarchy [OK]

Hint: Use nested plural nouns for related resources [OK]

Common Mistakes:

• Using verbs in paths like 'getCommentsForPost'
• Using query parameters instead of nested paths
• Using singular nouns inconsistently