POST for creating resources in Rest API - Step-by-Step Execution

Concept Flow - POST for creating resources

Client prepares data

↓

Client sends POST request

↓

Server receives request

↓

Server processes data

↓

Server creates resource

↓

Server sends response with status 201

↓

Client receives confirmation

This flow shows how a client sends data to create a resource using POST, and the server processes and confirms creation.

Execution Sample

Rest API

POST /items HTTP/1.1
Host: example.com
Content-Type: application/json

{"name": "New Item", "price": 10.99}

Client sends a POST request with JSON data to create a new item on the server.

Execution Table

Step	Action	Data Sent/Received	Server Status	Response
1	Client prepares JSON data	{"name": "New Item", "price": 10.99}	N/A	N/A
2	Client sends POST request	POST /items with JSON body	N/A	N/A
3	Server receives POST request	Receives JSON data	Processing	N/A
4	Server creates new resource	Stores item with name and price	201 Created	N/A
5	Server sends response	Includes Location header	201 Created	{"id": 101, "name": "New Item", "price": 10.99}
6	Client receives response	Receives confirmation and new resource data	N/A	Resource created with ID 101

💡 POST request completes after server confirms resource creation with status 201.

Variable Tracker

Variable	Start	After Step 1	After Step 3	After Step 4	Final
request_body	empty	{"name": "New Item", "price": 10.99}	{"name": "New Item", "price": 10.99}	{"name": "New Item", "price": 10.99}	sent to server
server_resource_id	none	none	none	101	101 (new resource created)
response_status	none	none	Processing	201 Created	201 Created

Key Moments - 3 Insights

Why does the server respond with status 201 instead of 200?

Status 201 means 'Created' and tells the client that a new resource was successfully made, as shown in execution_table row 4 and 5.

What is the purpose of the Location header in the server response?

The Location header gives the URL of the new resource, so the client knows where to find it, referenced in execution_table row 5.

Why must the client send data in the request body with POST?

POST creates a resource using the data sent; without it, the server wouldn't know what to create, as seen in execution_table row 1 and 2.

Visual Quiz - 3 Questions

Look at the execution_table, what is the server status at step 4?

A 201 Created

B 200 OK

C 404 Not Found

D 500 Internal Server Error

💡 Hint

Check the 'Server Status' column at step 4 in the execution_table.

At which step does the client receive confirmation that the resource was created?

A Step 5

B Step 3

C Step 6

D Step 2

💡 Hint

Look for when the client receives the response in the execution_table.

If the client did not send JSON data in step 1, what would likely happen?

A Server creates resource with default values

B Server responds with an error, e.g., 400 Bad Request

C Server responds with 201 Created anyway

D Client automatically retries sending data

💡 Hint

Consider the importance of data in the request_body variable in variable_tracker.

Concept Snapshot

POST request sends data to server to create a resource.
Server processes data and responds with status 201 Created.
Response includes new resource info and Location header.
Client uses response to confirm creation.
POST differs from GET by sending data in the request body.

Full Transcript

This visual trace shows how a POST request works to create a resource. First, the client prepares JSON data and sends it in a POST request to the server. The server receives the data, processes it, and creates a new resource with a unique ID. Then, the server responds with status 201 Created and includes the new resource details and a Location header pointing to the resource URL. Finally, the client receives this confirmation and knows the resource was successfully created. Key points include the meaning of status 201, the role of the Location header, and the necessity of sending data in the POST request body.

Practice

1. What is the primary purpose of the POST method in REST APIs?

easy

A. To create a new resource on the server

B. To retrieve data from the server

C. To update an existing resource completely

D. To delete a resource from the server

Solution

1. Step 1: Understand HTTP methods

   HTTP methods have specific roles: GET retrieves, POST creates, PUT updates, DELETE removes.

2. Step 2: Identify POST's role

   POST sends data to the server to create a new resource, unlike GET which only fetches data.

3. Final Answer:

   To create a new resource on the server -> Option A

4. Quick Check:

   POST = Create resource [OK]

Hint: POST is for sending data to create something new [OK]

Common Mistakes:

• Confusing POST with GET which only fetches data
• Thinking POST updates existing resources fully
• Assuming POST deletes resources

2. Which of the following is the correct way to send data in a POST request to create a resource?

easy

A. Include data in the URL query parameters

B. Send data in the request body as JSON

C. Send data as HTTP headers

D. Send data as a cookie

Solution

1. Step 1: Identify where POST data goes

   POST requests send data in the request body, not in URL or headers.

2. Step 2: Recognize common data format

   JSON is the standard format for sending structured data in the body for REST APIs.

3. Final Answer:

   Send data in the request body as JSON -> Option B

4. Quick Check:

   POST data = request body JSON [OK]

Hint: POST data goes in the body, not URL or headers [OK]

Common Mistakes:

• Putting data in URL query instead of body
• Trying to send data via headers
• Using cookies to send creation data

3. Given this Python code using the requests library, what will be the HTTP status code if the resource is created successfully?

import requests
url = 'https://api.example.com/items'
data = {'name': 'Book', 'price': 12.99}
response = requests.post(url, json=data)
print(response.status_code)

medium

A. 200

B. 404

C. 201

D. 500

Solution

1. Step 1: Understand POST success codes

   When a resource is created, the server usually returns HTTP status 201 Created.

2. Step 2: Analyze the code behavior

   The code sends a POST request with JSON data; if successful, response.status_code will be 201.

3. Final Answer:

   201 -> Option C

4. Quick Check:

   POST success = 201 Created [OK]

Hint: 201 means resource created successfully [OK]

Common Mistakes:

• Confusing 200 OK with 201 Created
• Assuming 404 means success
• Thinking 500 means success

4. You wrote this POST request code but get a 400 Bad Request error. What is the likely problem?

import requests
url = 'https://api.example.com/users'
data = {'username': 'alice'}
response = requests.post(url, data=data)
print(response.status_code)

medium

A. The data should be sent as JSON, not form data

B. The URL is incorrect for POST requests

C. POST requests cannot send data

D. The server does not support HTTPS

Solution

1. Step 1: Check data sending method

   Using data=data sends form-encoded data, but API expects JSON for POST creation.

2. Step 2: Fix data format

   Use json=data in requests.post to send JSON body, which the server accepts.

3. Final Answer:

   The data should be sent as JSON, not form data -> Option A

4. Quick Check:

   Send JSON with json= parameter [OK]

Hint: Use json= not data= to send JSON body [OK]

Common Mistakes:

• Sending form data instead of JSON
• Assuming URL is wrong without checking
• Thinking POST can't send data
• Ignoring HTTPS requirement

5. You want to create a new blog post resource with title and content using a POST request. Which of these JSON payloads correctly represents the data to send in the request body?

hard

A. ["title", "My Day", "content", "It was sunny."]

B. "title=My Day&content=It was sunny."

C. {"My Day": "title", "It was sunny.": "content"}

D. {"title": "My Day", "content": "It was sunny."}

Solution

1. Step 1: Understand JSON object structure

   JSON objects use key-value pairs with keys as strings and values as data.

2. Step 2: Identify correct JSON format

   {"title": "My Day", "content": "It was sunny."} correctly uses keys "title" and "content" with their string values in an object.

3. Final Answer:

   {"title": "My Day", "content": "It was sunny."} -> Option D

4. Quick Check:

   JSON object with keys and values = {"title": "My Day", "content": "It was sunny."} [OK]

Hint: JSON data must be key-value pairs inside braces {} [OK]

Common Mistakes:

• Using JSON arrays instead of objects
• Swapping keys and values
• Sending URL-encoded string instead of JSON