Request body structure in Rest API - Mini Project: Build & Apply

Understanding Request Body Structure in REST API

📖 Scenario: You are building a simple REST API that accepts user information in the request body. This is common when users submit forms on websites or apps.

🎯 Goal: Learn how to create and use the request body structure to send data to a REST API endpoint.

📋 What You'll Learn

Create a JSON object representing user data

Add a configuration variable for content type

Write code to send the JSON data in the request body

Print the response status to confirm the request

💡 Why This Matters

🌍 Real World

APIs often require sending data in the request body to create or update resources, like user profiles or orders.

💼 Career

Understanding request body structure is essential for backend and frontend developers working with REST APIs in web and mobile apps.

1

Create the user data JSON object

Create a JSON object called user_data with these exact key-value pairs: "name": "John Doe", "email": "[e-mail]", and "age": 30.

Rest API

# Create the user_data JSON object with name, email, and age
# Your code here

Need a hint?

Use curly braces {} to create a JSON object in your code.

2

Set the content type header

Create a variable called headers and set it to a dictionary with the key "Content-Type" and value "application/json".

Rest API

user_data = {
    "name": "John Doe",
    "email": "[e-mail]",
    "age": 30
}

# Create headers dictionary with Content-Type application/json
# Your code here

Need a hint?

Headers tell the server what kind of data you are sending.

3

Send the POST request with JSON body

Use the requests.post method to send a POST request to "https://example.com/api/users" with json=user_data and headers=headers. Store the response in a variable called response.

Rest API

user_data = {
    "name": "John Doe",
    "email": "[e-mail]",
    "age": 30
}

headers = {"Content-Type": "application/json"}

# Import requests and send POST request with json=user_data and headers=headers
# Your code here

Need a hint?

Use the json= parameter to send JSON data in the request body.

4

Print the response status code

Write a print statement to display response.status_code to confirm the request was sent.

Rest API

import requests

user_data = {
    "name": "John Doe",
    "email": "[e-mail]",
    "age": 30
}

headers = {"Content-Type": "application/json"}

response = requests.post("https://example.com/api/users", json=user_data, headers=headers)

# Print the response status code
# Your code here

Need a hint?

The status code tells you if the request was successful (like 200 or 201) or if there was an error.