Why consistent errors help developers in Rest API - Test Your Understanding

Practice - 5 Tasks

1fill in blank

easy

Complete the code to return a 404 error when a resource is not found.

Rest API

if resource is None:
    return [1](404, 'Resource not found')

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

Areturn

Babort

Cprint

Draise

Attempts:

3 left

💡 Hint

Common Mistakes

Using print instead of abort does not send an HTTP error.

Using raise without an exception class will cause a syntax error.

Using abort with a 404 status code sends a consistent error response to the client.

2fill in blank

medium

Complete the code to return a JSON error message with status 400.

Rest API

return [1]({'error': 'Bad request'}), 400

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

Ajsonify

Bjson

Cstr

Dprint

Attempts:

3 left

💡 Hint

Common Mistakes

Using json returns a string, not a response object.

Using print does not send a response to the client.

jsonify formats the dictionary as JSON and sets the correct headers.

3fill in blank

hard

Fix the error in the code to send a consistent 500 error response.

Rest API

try:
    process_request()
except Exception as e:
    return [1]({'error': str(e)}), 500

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

Astr

Bprint

Cjsonify

Dabort

Attempts:

3 left

💡 Hint

Common Mistakes

Using print does not send a response to the client.

Using abort without a message does not include error details.

Using jsonify ensures the error message is sent as JSON with the correct status code.

4fill in blank

hard

Fill both blanks to create a consistent error handler for 403 Forbidden errors.

Rest API

@app.errorhandler([1])
def forbidden_error(error):
    return [2]({'error': 'Forbidden'}), 403

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

A403

Bjsonify

C404

Dabort

Attempts:

3 left

💡 Hint

Common Mistakes

Using 404 instead of 403 changes the error meaning.

Using abort inside the handler can cause recursion.

The decorator uses the 403 status code, and jsonify sends the JSON error response.

5fill in blank

hard

Fill all three blanks to create a consistent error response with a custom message and status code.

Rest API

def error_response(message, code):
    response = [1]({'error': message})
    response.status_code = [2]
    return response

return error_response([3], 401)

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

Ajsonify

B401

C'Unauthorized access'

Dabort

Attempts:

3 left

💡 Hint

Common Mistakes

Setting status_code to a string instead of an integer.

Passing the message without quotes causes a syntax error.

jsonify creates the JSON response, 401 sets the status code, and the message is a string describing the error.

Practice

1. Why is it important for REST APIs to return consistent error messages?

easy

A. It makes the API slower to respond.

B. It helps developers quickly understand and fix issues.

C. It hides the real problem from developers.

D. It increases the size of the API response unnecessarily.

Solution

1. Step 1: Understand the role of error messages

   Error messages guide developers to identify what went wrong in the API call.

2. Step 2: Recognize the benefit of consistency

   Consistent errors use clear, predictable formats that make debugging faster and easier.

3. Final Answer:

   It helps developers quickly understand and fix issues. -> Option B

4. Quick Check:

   Consistent errors = faster debugging [OK]

Hint: Consistent errors make debugging faster and clearer [OK]

Common Mistakes:

• Thinking errors slow down the API
• Believing errors hide problems
• Assuming bigger responses are better

2. Which of the following is the correct way to send a consistent error response in a REST API?

easy

A. HTTP status 404 with a JSON body containing error code and message

B. HTTP status 200 with error details in the body

C. HTTP status 500 with no body

D. HTTP status 302 redirecting to an error page

Solution

1. Step 1: Identify proper HTTP status codes for errors

   404 means 'Not Found' and is appropriate for missing resources.

2. Step 2: Check for clear error details in response body

   Including a JSON body with error code and message helps developers understand the issue.

3. Final Answer:

   HTTP status 404 with a JSON body containing error code and message -> Option A

4. Quick Check:

   Use correct status + clear JSON error [OK]

Hint: Use proper HTTP status and JSON error body [OK]

Common Mistakes:

• Using status 200 for errors
• Sending no error details
• Redirecting instead of error response

3. Given this error response from a REST API:

{"error": {"code": "INVALID_INPUT", "message": "Username is required."}}

What is the main advantage of this format?

medium

A. It makes the API response smaller.

B. It hides the error details from users.

C. It prevents the API from returning success responses.

D. It allows developers to programmatically check error codes.

Solution

1. Step 1: Analyze the error response structure

   The response includes an error code and a message inside a JSON object.

2. Step 2: Understand the benefit of error codes

   Developers can write code to detect specific error codes and handle them accordingly.

3. Final Answer:

   It allows developers to programmatically check error codes. -> Option D

4. Quick Check:

   Error codes enable automated error handling [OK]

Hint: Error codes help automate error handling [OK]

Common Mistakes:

• Thinking error details are hidden
• Assuming smaller response is main goal
• Confusing error with success responses

4. A developer notices inconsistent error responses from an API: sometimes errors are strings, sometimes JSON objects. What is the best way to fix this?

medium

A. Return errors only as plain text strings.

B. Remove error messages to avoid confusion.

C. Standardize all error responses to a JSON object with code and message fields.

D. Use different formats depending on the error type.

Solution

1. Step 1: Identify the problem with inconsistent formats

   Different formats make it hard for developers to parse and handle errors reliably.

2. Step 2: Choose a consistent error format

   Using a JSON object with standard fields like code and message ensures uniformity and clarity.

3. Final Answer:

   Standardize all error responses to a JSON object with code and message fields. -> Option C

4. Quick Check:

   Consistent JSON error format improves developer experience [OK]

Hint: Use one JSON error format for all errors [OK]

Common Mistakes:

• Removing error messages
• Using plain text inconsistently
• Mixing formats by error type

5. You are designing a REST API for a banking app. How can consistent error responses improve the app's reliability and developer experience?

hard

A. By providing clear error codes and messages, the app can handle failures gracefully and inform users properly.

B. By hiding all errors to avoid confusing users.

C. By returning different error formats for each endpoint to keep responses unique.

D. By always returning HTTP 200 status even on errors to simplify client code.

Solution

1. Step 1: Understand the importance of clear error communication

   Clear error codes and messages help the app detect and respond to problems correctly.

2. Step 2: Recognize how consistent errors improve reliability

   Consistent errors allow developers to write predictable error handling, improving user experience and app stability.

3. Final Answer:

   By providing clear error codes and messages, the app can handle failures gracefully and inform users properly. -> Option A

4. Quick Check:

   Clear, consistent errors = better app reliability [OK]

Hint: Clear errors help apps handle problems smoothly [OK]

Common Mistakes:

• Hiding errors from users
• Using inconsistent error formats
• Ignoring HTTP status codes