Example requests and responses in Rest API - Mini Project: Build & Apply

Example requests and responses

📖 Scenario: You are learning how to work with REST APIs by creating example requests and responses in Python.

🎯 Goal: Build a simple Python script that shows an example GET request and its expected JSON response.

📋 What You'll Learn

Create a dictionary representing the JSON response from an API

Create a string variable representing the example GET request URL

Print the example request and the JSON response

💡 Why This Matters

🌍 Real World

Developers often write example requests and responses to document APIs or test them.

💼 Career

Understanding how to format and display API requests and responses is important for backend and frontend developers.

1

Create example JSON response data

Create a dictionary called response_data with these exact entries: 'userId': 1, 'id': 101, 'title': 'Learn REST APIs', 'completed': false

Rest API

# Create the dictionary response_data with the given entries
# Your code here

Need a hint?

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

2

Create example GET request URL

Create a string variable called example_request and set it to the exact value 'GET /todos/101 HTTP/1.1'

Rest API

response_data = {'userId': 1, 'id': 101, 'title': 'Learn REST APIs', 'completed': False}
# Create the string example_request with the exact GET request
# Your code here

Need a hint?

Use quotes to create a string exactly as shown.

3

Prepare output strings

Create a string variable called response_json that converts response_data to a JSON string using import json and json.dumps()

Rest API

response_data = {'userId': 1, 'id': 101, 'title': 'Learn REST APIs', 'completed': False}
example_request = 'GET /todos/101 HTTP/1.1'
# Import json and convert response_data to JSON string in response_json
# Your code here

Need a hint?

Use import json at the top and then json.dumps() to convert the dictionary.

4

Print example request and response

Print the example_request string and then print the response_json string on separate lines

Rest API

import json
response_data = {'userId': 1, 'id': 101, 'title': 'Learn REST APIs', 'completed': False}
example_request = 'GET /todos/101 HTTP/1.1'
response_json = json.dumps(response_data)
# Print example_request and response_json on separate lines
# Your code here

Need a hint?

Use two print statements, one for the request and one for the JSON response.