Human-readable error messages in Rest API - Step-by-Step Execution

Concept Flow - Human-readable error messages

Client sends request

↓

Server processes request

↓

Error occurs?

No→Send success response

Yes↓

Generate error message

↓

Format message human-readable

↓

Send error response to client

The server checks for errors during request processing, creates a clear message if an error happens, and sends it back to the client.

Execution Sample

Rest API

def get_user(user_id):
    if user_id <= 0:
        return {"error": "Invalid user ID. Must be positive."}
    # fetch user logic
    return {"user": "User data here"}

This code checks if the user ID is valid and returns a clear error message if not.

Execution Table

Step	Input user_id	Condition	Action	Output
1	-1	user_id <= 0 is True	Return error message	{"error": "Invalid user ID. Must be positive."}
2	5	user_id <= 0 is False	Fetch user data	{"user": "User data here"}
3	0	user_id <= 0 is True	Return error message	{"error": "Invalid user ID. Must be positive."}

💡 Stops after returning either error or user data response

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3
user_id	undefined	-1	5	0
output	undefined	{"error": "Invalid user ID. Must be positive."}	{"user": "User data here"}	{"error": "Invalid user ID. Must be positive."}

Key Moments - 2 Insights

Why do we return a dictionary with an 'error' key instead of just a string?

Returning a dictionary with an 'error' key helps clients easily identify and handle errors, as shown in the execution_table rows 1 and 3.

What happens if the user_id is zero?

The condition user_id <= 0 is True, so the function returns the error message, as seen in execution_table row 3.

Visual Quiz - 3 Questions

Look at the execution_table, what is the output when user_id is 5?

A {"error": "Invalid user ID. Must be positive."}

B {"user": "User data here"}

C None

D An exception is raised

💡 Hint

Check execution_table row 2 under Output column

At which step does the function return an error message?

A Step 2

B Step 3 only

C Step 1 and Step 3

D No error message is returned

💡 Hint

Look at execution_table rows 1 and 3 under Action and Output

If we change the condition to user_id < 0, what happens when user_id is 0?

A Returns user data

B Returns error message

C Raises exception

D Returns None

💡 Hint

Check how condition user_id <= 0 vs user_id < 0 affects step 3 in variable_tracker

Concept Snapshot

Human-readable error messages:
- Check for errors in input or processing
- Return clear, simple messages in a structured format (like JSON)
- Use keys like 'error' to help clients detect problems
- Avoid technical jargon
- Always send a response explaining what went wrong

Full Transcript

This visual trace shows how a REST API function handles errors by checking the user_id input. If the user_id is zero or negative, the function returns a JSON object with an 'error' key and a clear message. If the user_id is positive, it returns user data. The execution table tracks each step, showing conditions checked and outputs returned. The variable tracker follows user_id and output values through each step. Key moments clarify why structured error messages are used and what happens with boundary values. The quiz tests understanding of outputs and condition effects. This helps beginners see how to make APIs send friendly error messages clients can understand.