Noun-based resource naming in Rest API - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to name the resource correctly in a REST API endpoint.

Rest API

GET /[1]

Drag options to blanks, or click blank then click option'

AuserList

BgetUser

CfetchUsers

Dusers

Attempts:

3 left

💡 Hint

Common Mistakes

Using verbs like 'getUser' instead of nouns.

Using singular nouns for collections.

In REST API design, resource names should be nouns, usually plural. So users is correct.

2fill in blank

medium

Complete the code to correctly name the resource for a single item in a REST API endpoint.

Rest API

GET /users/[1]

Drag options to blanks, or click blank then click option'

Aid

B123

Clist

Dget

Attempts:

3 left

💡 Hint

Common Mistakes

Using verbs or words like 'get' or 'list' instead of an ID.

Using 'id' literally instead of an example or placeholder.

To get a single user, the endpoint uses the user's ID as a path parameter, e.g., /users/123.

3fill in blank

hard

Fix the error in the resource naming by completing the code with the correct noun-based resource name.

Rest API

POST /[1]

Drag options to blanks, or click blank then click option'

AcreateUser

BaddUser

Cusers

DnewUser

Attempts:

3 left

💡 Hint

Common Mistakes

Using verbs in resource names for POST endpoints.

Using singular nouns instead of plural.

POST requests should be sent to the collection resource, which is a plural noun like users.

4fill in blank

hard

Fill both blanks to correctly name the resource and its identifier in the REST API endpoint.

Rest API

DELETE /[1]/[2]

Drag options to blanks, or click blank then click option'

Ausers

Bposts

C456

D789

Attempts:

3 left

💡 Hint

Common Mistakes

Using singular nouns for resource names.

Using non-numeric or verb values as IDs.

The resource is posts (plural noun), and 789 is an example ID to delete a specific post.

5fill in blank

hard

Fill all three blanks to create a correct REST API endpoint for updating a resource.

Rest API

PUT /[1]/[2]/[3]

Drag options to blanks, or click blank then click option'

Ausers

B123

Cprofile

Dsettings

Attempts:

3 left

💡 Hint

Common Mistakes

Using verbs instead of nouns for resource names.

Using invalid IDs or missing sub-resource names.

The endpoint updates the profile sub-resource of user 123 in the users collection.

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