500 Internal Server Error in Rest API - Mini Project: Build & Apply

Handling 500 Internal Server Error in a REST API

📖 Scenario: You are building a simple REST API for a bookstore. Sometimes, unexpected errors happen on the server, causing a 500 Internal Server Error. You want to handle this error gracefully and return a friendly message to the user.

🎯 Goal: Build a small REST API using Flask that simulates a 500 Internal Server Error and handles it by returning a clear JSON message.

📋 What You'll Learn

Create a Flask app with a route /books

Add a configuration variable simulate_error to control error simulation

Use a try-except block to simulate and catch the 500 Internal Server Error

Return a JSON response with an error message when the error occurs

💡 Why This Matters

🌍 Real World

Web servers often face unexpected problems. Handling 500 Internal Server Errors gracefully helps users understand that something went wrong without exposing technical details.

💼 Career

Backend developers must know how to handle server errors properly to build reliable and user-friendly APIs.

1

Create the Flask app and /books route

Write code to import Flask, create an app called app, and add a route /books that returns a list of book titles as JSON.

Rest API

from flask import Flask, jsonify

app = Flask(__name__)

# Create a route '/books' that returns a JSON list of books
# Your code here

Hint

Use @app.route('/books') to create the route and return a JSON list using jsonify.

2

Add a configuration variable simulate_error

Add a variable called simulate_error and set it to True to simulate a server error.

Rest API

from flask import Flask, jsonify

app = Flask(__name__)
simulate_error = True  # Add this variable to control error simulation

@app.route('/books')
def books():
    return jsonify(['The Hobbit', '1984', 'Pride and Prejudice'])

Hint

Just create a variable simulate_error and set it to True.

3

Simulate and handle the 500 Internal Server Error

Modify the books function to use a try-except block. If simulate_error is True, raise an Exception. Catch the exception and return a JSON response with {'error': 'Internal Server Error'} and status code 500.

Rest API

from flask import Flask, jsonify

app = Flask(__name__)
simulate_error = True

@app.route('/books')
def books():
    # Use try-except to simulate and handle error
    # Your code here

Hint

Use try and except Exception to catch errors. Raise an exception if simulate_error is True.

4

Run the app and print the error response

Add code to run the Flask app only if the file is run directly. Then, simulate a request to /books and print the JSON response and status code.

Rest API

from flask import Flask, jsonify

app = Flask(__name__)
simulate_error = True

@app.route('/books')
def books():
    try:
        if simulate_error:
            raise Exception('Simulated server error')
        return jsonify(['The Hobbit', '1984', 'Pride and Prejudice'])
    except Exception:
        return jsonify({'error': 'Internal Server Error'}), 500

if __name__ == '__main__':
    # Run the app and print the response from /books
    # Your code here

Hint

Use app.test_client() to simulate a request and print response.json and response.status_code.

Practice

1. What does a 500 Internal Server Error usually indicate in a REST API?

easy

A. The client sent a request with invalid syntax.

B. The client is not authorized to access the requested resource.

C. The requested resource was not found on the server.

D. The server encountered an unexpected condition that prevented it from fulfilling the request.

Solution

1. Step 1: Understand HTTP status codes

   HTTP status codes starting with 5 indicate server errors, meaning the problem is on the server side.

2. Step 2: Identify the meaning of 500 Internal Server Error

   500 means the server failed unexpectedly to complete the request due to an internal problem like a bug or crash.

3. Final Answer:

   The server encountered an unexpected condition that prevented it from fulfilling the request. -> Option D

4. Quick Check:

   500 error = server problem [OK]

Hint: 500 error means server failed internally, not client fault [OK]

Common Mistakes:

• Confusing 500 error with client errors like 400 or 404
• Thinking 500 means unauthorized access
• Assuming 500 means resource not found

2. Which of the following is the correct way to respond with a 500 Internal Server Error in a REST API using HTTP status codes?

easy

A. Return status code 404 with an error message.

B. Return status code 500 with an error message.

C. Return status code 200 with an error message.

D. Return status code 401 with an error message.

Solution

1. Step 1: Recall HTTP status code meanings

   500 is the standard code for Internal Server Error indicating server failure.

2. Step 2: Match status code to error type

   To indicate a server error, the response must use status code 500 along with an error message.

3. Final Answer:

   Return status code 500 with an error message. -> Option B

4. Quick Check:

   Use 500 status code for internal server errors [OK]

Hint: Use 500 status code for server errors, not 404 or 401 [OK]

Common Mistakes:

• Using 404 or 401 instead of 500 for server errors
• Returning 200 OK with error message
• Confusing client error codes with server error codes

3. Consider this Python Flask code snippet for a REST API endpoint:

from flask import Flask, jsonify
app = Flask(__name__)

@app.route('/data')
def get_data():
    try:
        result = 10 / 0  # This will cause an error
        return jsonify({'result': result})
    except Exception:
        return jsonify({'error': 'Server error occurred'}), 500

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

What will the client receive when requesting /data?

medium

A. A JSON response with {'result': 0} and status 200.

B. A JSON response with {'error': 'Server error occurred'} and status 404.

C. A JSON response with {'error': 'Server error occurred'} and status 500.

D. A server crash with no response.

Solution

1. Step 1: Analyze the code's try-except block

   The code tries to divide 10 by 0, which raises a ZeroDivisionError, triggering the except block.

2. Step 2: Check the except block response

   The except block returns a JSON error message with status code 500 indicating an internal server error.

3. Final Answer:

   A JSON response with {'error': 'Server error occurred'} and status 500. -> Option C

4. Quick Check:

   Exception triggers 500 error response [OK]

Hint: Errors in try block trigger 500 response in except [OK]

Common Mistakes:

• Expecting division by zero to return 0
• Confusing 404 with 500 status code
• Assuming server crashes without response

4. You have a REST API that sometimes returns a 500 Internal Server Error. Which of these is the best debugging step to find the cause?

medium

A. Review server logs to find error details and stack traces.

B. Restart the client application.

C. Clear browser cache and cookies.

D. Check the client request syntax for errors.

Solution

1. Step 1: Understand 500 error origin

   500 errors come from server issues, so client-side fixes won't help.

2. Step 2: Identify debugging method

   Server logs contain error details and stack traces that help find the root cause of server errors.

3. Final Answer:

   Review server logs to find error details and stack traces. -> Option A

4. Quick Check:

   Server logs reveal 500 error causes [OK]

Hint: Check server logs first for 500 errors, not client fixes [OK]

Common Mistakes:

• Blaming client syntax for server errors
• Trying client-side fixes like clearing cache
• Ignoring server logs and guessing

5. You are designing a REST API that sometimes fails with a 500 Internal Server Error due to database connection timeouts. Which approach best reduces these errors?

hard

A. Implement retry logic with exponential backoff on the server side.

B. Return 404 Not Found when the database is unreachable.

C. Ignore the error and return an empty response with status 200.

D. Ask clients to refresh the page manually.

Solution

1. Step 1: Understand cause of 500 errors

   Database timeouts cause server failures, leading to 500 errors.

2. Step 2: Choose best mitigation strategy

   Retry logic with exponential backoff helps the server recover from temporary database issues automatically.

3. Final Answer:

   Implement retry logic with exponential backoff on the server side. -> Option A

4. Quick Check:

   Retry with backoff reduces server errors [OK]

Hint: Use retry with backoff to handle transient server errors [OK]

Common Mistakes:

• Returning wrong status codes like 404 for server errors
• Ignoring errors and sending wrong success responses
• Relying on clients to fix server problems