POST for creating resources in Rest API - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the main purpose of the POST method in REST APIs?

The POST method is used to create new resources on the server. It sends data to the server to add a new item.

beginner

Which HTTP status code usually indicates a successful resource creation with POST?

201 Created - This status code means the resource was successfully created on the server.

beginner

In a POST request, where is the data for the new resource typically sent?

The data is sent in the request body, usually formatted as JSON or XML.

intermediate

True or False: POST requests are idempotent, meaning sending the same POST request multiple times has the same effect as sending it once.

False. POST requests are not idempotent because each request can create a new resource, causing different effects.

intermediate

What is a common response header included after a successful POST request creating a resource?

The Location header, which provides the URL of the newly created resource.

What does a POST request typically do in a REST API?

A Create a new resource

B Retrieve data

C Update an existing resource

D Delete a resource

POST is used to create new resources on the server.

Which HTTP status code means a resource was successfully created?

A 200 OK

B 404 Not Found

C 201 Created

D 500 Internal Server Error

201 Created indicates successful creation of a resource.

Where is the data sent in a POST request?

A In the response body

B In the request headers

C In the URL query string

D In the request body

POST request data is sent in the request body.

Which header often tells you the URL of the new resource after a POST?

A Content-Type

B Location

C Authorization

D Accept

The Location header provides the URL of the newly created resource.

Are POST requests idempotent?

A No, they can create multiple resources

B Only when updating resources

C Only if the server says so

D Yes, always

POST requests are not idempotent because each call can create a new resource.

Explain how a POST request is used to create a resource in a REST API.

Think about sending data to the server and what the server returns.

What is the difference between POST and GET methods in REST APIs?

Consider what each method does and how they handle data.

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