Request body structure in Rest API - Step-by-Step Execution

Concept Flow - Request body structure

Client prepares data

↓

Client sends HTTP request

↓

Server receives request

↓

Server reads request body

↓

Server processes data

↓

Server sends response

This flow shows how a client sends data in the request body to a server, which reads and processes it.

Execution Sample

Rest API

POST /api/users HTTP/1.1
Content-Type: application/json

{
  "name": "Alice",
  "age": 30
}

This HTTP POST request sends a JSON body with user data to the server.

Execution Table

Step	Action	Data/Content	Result
1	Client prepares data	{"name": "Alice", "age": 30}	Data ready to send
2	Client sends HTTP POST request	Headers + JSON body	Request sent to server
3	Server receives request	Headers + JSON body	Request accepted
4	Server reads Content-Type header	application/json	Determines body format
5	Server reads request body	{"name": "Alice", "age": 30}	Body parsed as JSON
6	Server processes data	Parsed JSON object	User data stored or used
7	Server sends response	Status 201 Created	Client notified of success

💡 Request processing ends after server sends response to client

Variable Tracker

Variable	Start	After Step 1	After Step 5	Final
request_body	empty	{"name": "Alice", "age": 30}	{"name": "Alice", "age": 30}	parsed JSON object

Key Moments - 2 Insights

Why does the server need the Content-Type header before reading the body?

The Content-Type header tells the server how to interpret the request body (e.g., JSON, XML). Without it, the server might not parse the data correctly (see step 4 in execution_table).

What happens if the request body is empty?

If the body is empty, the server may receive no data to process, which can cause errors or default behavior. The execution_table shows the body content at step 5; if empty, parsing would fail or return null.

Visual Quiz - 3 Questions

Look at the execution table, what is the content of the request body at step 5?

A {"name": "Alice", "age": 30}

B Empty string

C Status 201 Created

D application/json

💡 Hint

Check the 'Data/Content' column at step 5 in the execution_table.

At which step does the server determine how to parse the request body?

A Step 2

B Step 6

C Step 4

D Step 7

💡 Hint

Look for when the server reads the Content-Type header in the execution_table.

If the client sends data in XML instead of JSON, which part of the flow changes?

A Step 1: Client prepares data

B All of the above

C Step 5: Server reads request body

D Step 4: Server reads Content-Type header

💡 Hint

Consider how data format affects preparation, header, and parsing steps in the execution_table.

Concept Snapshot

Request body structure:
- Sent in HTTP request after headers
- Content-Type header defines format (e.g., application/json)
- Server reads and parses body accordingly
- Common formats: JSON, XML, form data
- Used to send data like user info or files

Full Transcript

This visual execution shows how a client sends data in the request body of an HTTP request. The client first prepares the data, for example, a JSON object with user details. Then it sends the HTTP POST request including headers and the body. The server receives the request and reads the Content-Type header to know how to parse the body. It then reads and parses the body data accordingly. After processing the data, the server sends a response back to the client. Key points include the importance of the Content-Type header and the structure of the request body data.

Practice

1. What is the main purpose of the request body in a REST API POST request?

easy

A. To define the HTTP method used

B. To send data from the client to the server

C. To specify the URL of the API endpoint

D. To set the server response status code

Solution

1. Step 1: Understand the role of request body

   The request body contains the data sent by the client to the server, usually in POST or PUT requests.

2. Step 2: Differentiate from other parts of the request

   The URL specifies the endpoint, the method defines the action, and the status code is part of the response, not the request body.

3. Final Answer:

   To send data from the client to the server -> Option B

4. Quick Check:

   Request body = data sent to server [OK]

Hint: Request body carries data sent to server in POST/PUT [OK]

Common Mistakes:

• Confusing request body with URL or headers
• Thinking request body sets HTTP method
• Mixing request body with response status

2. Which of the following is the correct way to indicate JSON data in the request body header?

easy

A. Content-Type: text/plain

B. Content-Type: application/xml

C. Content-Type: application/json

D. Content-Type: multipart/form-data

Solution

1. Step 1: Identify the header for JSON data

   The header Content-Type: application/json tells the server the body contains JSON formatted data.

2. Step 2: Compare with other content types

   text/plain is plain text, multipart/form-data is for file uploads, and application/xml is for XML data.

3. Final Answer:

   Content-Type: application/json -> Option C

4. Quick Check:

   JSON header = application/json [OK]

Hint: Use application/json for JSON request bodies [OK]

Common Mistakes:

• Using text/plain for JSON data
• Forgetting to set Content-Type header
• Using multipart/form-data without files

3. Given this JSON request body sent to an API:

{
  "name": "Alice",
  "age": 30
}

What will the server receive as the value of age?

medium

A. Undefined

B. "30" (string)

C. null

D. 30 (number)

Solution

1. Step 1: Analyze the JSON data types

   The value for age is written as 30 without quotes, so it is a number, not a string.

2. Step 2: Understand server parsing

   The server parses JSON and keeps numbers as numbers, so age will be the number 30.

3. Final Answer:

   30 (number) -> Option D

4. Quick Check:

   Unquoted numbers in JSON = number type [OK]

Hint: Numbers in JSON have no quotes, so parsed as numbers [OK]

Common Mistakes:

• Assuming all JSON values are strings
• Confusing number and string types
• Ignoring JSON parsing rules

4. You send this request body:

{
  "username": "bob",
  "password": "1234"
}

But the server returns a 400 Bad Request error. What is a likely cause?

medium

A. Missing Content-Type header or wrong format

B. The username is too short

C. The password is numeric

D. The request method is GET

Solution

1. Step 1: Check request headers and format

   A 400 Bad Request often means the server cannot parse the body, commonly due to missing or incorrect Content-Type header.

2. Step 2: Evaluate other options

   Username length or password content usually cause validation errors, not 400 errors. GET requests do not have bodies, but the question implies a body was sent.

3. Final Answer:

   Missing Content-Type header or wrong format -> Option A

4. Quick Check:

   400 error often = bad or missing Content-Type [OK]

Hint: Always set correct Content-Type header to avoid 400 errors [OK]

Common Mistakes:

• Ignoring Content-Type header
• Assuming 400 means validation error
• Confusing GET with POST request body

5. You want to send a nested JSON object in the request body to create a user with address info:

{
  "name": "Eve",
  "address": {
    "street": "123 Main St",
    "city": "Townsville"
  }
}

Which Content-Type header and body format should you use to ensure the server correctly understands this nested data?

hard

A. Content-Type: application/json with the JSON body as shown

B. Content-Type: text/plain with JSON body as string

C. Content-Type: application/x-www-form-urlencoded with nested keys

D. Content-Type: multipart/form-data with JSON inside a file

Solution

1. Step 1: Identify correct header for nested JSON

   Nested JSON requires application/json Content-Type so the server parses the structure correctly.

2. Step 2: Evaluate other formats

   text/plain treats body as plain text, application/x-www-form-urlencoded does not support nested objects well, and multipart/form-data is for files, not nested JSON.

3. Final Answer:

   Content-Type: application/json with the JSON body as shown -> Option A

4. Quick Check:

   Nested JSON needs application/json header [OK]

Hint: Use application/json header for nested JSON objects [OK]

Common Mistakes:

• Using form-urlencoded for nested JSON
• Sending JSON as plain text without header
• Uploading JSON as file instead of body