Why consistent errors help developers in Rest API - See It in Action

Why Consistent Errors Help Developers

📖 Scenario: Imagine you are building a simple REST API that returns user data. When something goes wrong, like a user not found or invalid input, your API should send back clear and consistent error messages. This helps developers who use your API understand what went wrong and fix their requests quickly.

🎯 Goal: You will create a small Python program that simulates API responses with consistent error messages. You will define a dictionary of users, set a user ID to look up, write code to check if the user exists, and print a consistent error message if not.

📋 What You'll Learn

Create a dictionary called users with exact entries: 1: 'Alice', 2: 'Bob', 3: 'Charlie'

Create a variable called user_id and set it to 4

Use an if statement to check if user_id is in users

If the user is not found, print the exact error message: {'error': 'User not found', 'code': 404}

💡 Why This Matters

🌍 Real World

APIs need to send clear and consistent error messages so developers can fix issues fast without confusion.

💼 Career

Understanding how to handle errors clearly is important for backend developers, API designers, and anyone building software that others use.

1

Create the user data dictionary

Create a dictionary called users with these exact entries: 1: 'Alice', 2: 'Bob', 3: 'Charlie'

Rest API

# Create the users dictionary with IDs and names
# Your code here

Need a hint?

Use curly braces {} to create a dictionary with keys and values.

2

Set the user ID to look up

Create a variable called user_id and set it to 4

Rest API

users = {1: 'Alice', 2: 'Bob', 3: 'Charlie'}
# Set user_id to 4
# Your code here

Need a hint?

Just assign the number 4 to the variable user_id.

3

Check if the user exists

Use an if statement to check if user_id is in users. If not, prepare to print an error message.

Rest API

users = {1: 'Alice', 2: 'Bob', 3: 'Charlie'}
user_id = 4

# Check if user_id is in users
# Your code here

Need a hint?

Use if user_id not in users: to check if the user ID is missing.

4

Print the consistent error message

Inside the if block, print the exact error message: {'error': 'User not found', 'code': 404}

Rest API

users = {1: 'Alice', 2: 'Bob', 3: 'Charlie'}
user_id = 4

if user_id not in users:
    # Print the error message
    # Your code here

Need a hint?

Use print() to show the error dictionary exactly as given.