Avoiding verbs in URLs in Rest API

Introduction

URLs should describe things, not actions. This makes them easier to understand and use.

When designing web APIs for managing resources like users or products.

When you want URLs to be simple and predictable for developers.

When you want to follow common web standards for REST APIs.

When you want to separate the action from the URL and use HTTP methods instead.

When you want your API to be easier to maintain and extend.

Syntax

Rest API

/resources
/resources/{id}

Use nouns (things) in URLs, not verbs (actions).

Use HTTP methods like GET, POST, PUT, DELETE to express actions.

Examples

Use HTTP methods to perform actions on the users resource.

Rest API

GET /users
POST /users
GET /users/123
PUT /users/123
DELETE /users/123

URLs represent the orders resource and specific order by ID.

Rest API

/orders
/orders/456

Do not put verbs like get, create, or delete in URLs.

Rest API

Avoid: /getUser
Avoid: /createOrder
Avoid: /deleteProduct

Sample Program

This simple API uses URLs with nouns only. Actions are done by HTTP methods like GET and POST.

Rest API

from flask import Flask, jsonify, request

app = Flask(__name__)

users = {"1": {"name": "Alice"}, "2": {"name": "Bob"}}

@app.route('/users', methods=['GET'])
def list_users():
    return jsonify(users)

@app.route('/users/<user_id>', methods=['GET'])
def get_user(user_id):
    user = users.get(user_id)
    if user:
        return jsonify(user)
    return jsonify({"error": "User not found"}), 404

@app.route('/users', methods=['POST'])
def create_user():
    data = request.json
    new_id = str(len(users) + 1)
    users[new_id] = {"name": data.get('name', 'Unknown')}
    return jsonify({"id": new_id}), 201

if __name__ == '__main__':
    app.run(debug=True)

Important Notes

HTTP methods tell what action to do, so URLs stay clean and simple.

Using nouns in URLs helps everyone understand what the URL points to.

Keep URLs consistent and predictable for easier API use.

Summary

Use nouns, not verbs, in URLs to name resources.

Use HTTP methods (GET, POST, PUT, DELETE) to express actions.

This makes APIs easier to understand and maintain.

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