Response envelope patterns in Rest API - Mini Project: Build & Apply

Response Envelope Pattern in REST API

📖 Scenario: You are building a simple REST API that returns data about books. To keep the API responses consistent and easy to understand, you want to wrap the actual data inside a response envelope. This envelope will include a status field, a message field, and a data field containing the real information.

🎯 Goal: Create a Python dictionary that represents a response envelope pattern for a REST API. You will start by creating the data, then add status and message fields, then combine them into the envelope, and finally print the full response.

📋 What You'll Learn

Create a dictionary called book with keys title, author, and year with exact values.

Create a variable called status with the value "success".

Create a variable called message with the value "Book data retrieved successfully.".

Create a dictionary called response_envelope with keys status, message, and data where data holds the book dictionary.

Print the response_envelope dictionary.

💡 Why This Matters

🌍 Real World

APIs often use response envelopes to make sure every response has a clear status, message, and data. This helps clients understand if the request was successful and what data was returned.

💼 Career

Knowing how to structure API responses is important for backend developers, API designers, and anyone working with web services to ensure clear communication between servers and clients.

1

Create the book data dictionary

Create a dictionary called book with these exact entries: 'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald', and 'year': 1925.

Rest API

# Create the book dictionary with title, author, and year
# Your code here

Need a hint?

Use curly braces {} to create a dictionary. Put the keys and values exactly as shown.

2

Add status and message variables

Create a variable called status and set it to "success". Then create a variable called message and set it to "Book data retrieved successfully.".

Rest API

book = {'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald', 'year': 1925}
# Create status and message variables
# Your code here

Need a hint?

Use simple assignment with = to create the variables.

3

Create the response envelope dictionary

Create a dictionary called response_envelope with keys status, message, and data. Set status to the variable status, message to the variable message, and data to the book dictionary.

Rest API

book = {'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald', 'year': 1925}
status = "success"
message = "Book data retrieved successfully."
# Create the response_envelope dictionary
# Your code here

Need a hint?

Use a dictionary with keys and assign the variables and dictionary as values.

4

Print the response envelope

Write a print statement to display the response_envelope dictionary.

Rest API

book = {'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald', 'year': 1925}
status = "success"
message = "Book data retrieved successfully."
response_envelope = {'status': status, 'message': message, 'data': book}
# Print the response_envelope
# Your code here

Need a hint?

Use print(response_envelope) to show the final dictionary.