Noun-based resource naming in Rest API

Introduction

We use noun-based names for resources in APIs to clearly show what data or thing we are working with. It makes the API easy to understand and use.

When creating an API to manage users, use nouns like 'users' to represent user data.

When building an API for a blog, use nouns like 'posts' and 'comments' to name resources.

When designing an API for a store, use nouns like 'products' and 'orders' to represent items and purchases.

Syntax

Rest API

/resource
/resource/{id}
/resource/{id}/subresource

Use plural nouns for resource names (e.g., 'users', 'products').

Use path parameters (like {id}) to specify a single resource item.

Examples

'/users' refers to all users, '/users/123' refers to the user with ID 123.

Rest API

/users
/users/123

'/products' is the list of products, '/products/456/reviews' is the reviews for product 456.

Rest API

/products
/products/456/reviews

Sample Program

This shows common HTTP methods with noun-based resource naming for a 'books' resource.

Rest API

GET /books
GET /books/10
POST /books
PUT /books/10
DELETE /books/10

Important Notes

Always use nouns, not verbs, for resource names to keep APIs consistent.

Use plural form for collections to clearly indicate multiple items.

Use HTTP methods (GET, POST, PUT, DELETE) to define actions on resources.

Summary

Noun-based naming makes APIs clear and easy to use.

Use plural nouns for resource paths.

Use HTTP methods to perform actions on these noun resources.

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