Batch create endpoint design in Rest API - Mini Project: Build & Apply

Batch Create Endpoint Design

📖 Scenario: You are building a simple REST API for a bookstore. The API should allow clients to add multiple new books at once using a batch create endpoint.This is useful when a bookstore wants to upload many new books in one request instead of sending many separate requests.

🎯 Goal: Create a batch create endpoint that accepts a list of books and returns a response confirming the books were added.You will design the data structure for the books, configure a helper variable for counting, implement the batch creation logic, and output the result.

📋 What You'll Learn

Create a list variable named new_books with exactly three book dictionaries.

Each book dictionary must have keys title and author with string values.

Create a variable named added_count initialized to zero.

Use a for loop with variable book to iterate over new_books.

Inside the loop, increment added_count by 1 for each book.

Print a message showing how many books were added using print().

💡 Why This Matters

🌍 Real World

Batch create endpoints are common in APIs to efficiently add many records at once, saving time and network resources.

💼 Career

Understanding batch operations is important for backend developers building scalable APIs and for frontend developers consuming such APIs.

1

Create the list of new books

Create a list called new_books with these exact dictionaries: {'title': 'The Hobbit', 'author': 'J.R.R. Tolkien'}, {'title': '1984', 'author': 'George Orwell'}, and {'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'}.

Rest API

# Create the list new_books with three book dictionaries
# Your code here

Hint

Use a list with three dictionaries. Each dictionary has keys 'title' and 'author' with string values.

2

Add a counter variable

Create a variable called added_count and set it to 0 to count how many books are added.

Rest API

new_books = [
    {'title': 'The Hobbit', 'author': 'J.R.R. Tolkien'},
    {'title': '1984', 'author': 'George Orwell'},
    {'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'}
]
# Create added_count variable and set to 0
# Your code here

Hint

Just create a variable named added_count and assign 0 to it.

3

Implement batch creation logic

Use a for loop with variable book to iterate over new_books. Inside the loop, increase added_count by 1 for each book.

Rest API

new_books = [
    {'title': 'The Hobbit', 'author': 'J.R.R. Tolkien'},
    {'title': '1984', 'author': 'George Orwell'},
    {'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'}
]
added_count = 0
# Use a for loop to count each book added
# Your code here

Hint

Use a for loop: for book in new_books: and inside it add 1 to added_count.

4

Print the result

Write a print() statement that outputs exactly: "Added 3 books successfully." using the added_count variable inside an f-string.

Rest API

new_books = [
    {'title': 'The Hobbit', 'author': 'J.R.R. Tolkien'},
    {'title': '1984', 'author': 'George Orwell'},
    {'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'}
]
added_count = 0
for book in new_books:
    added_count += 1
# Print the message showing how many books were added
# Your code here

Hint

Use print(f"Added {added_count} books successfully.") to show the result.

Practice

1. What HTTP method is typically used for a batch create endpoint in a REST API?

easy

A. DELETE

B. POST

C. GET

D. PUT

Solution

1. Step 1: Understand HTTP methods for data creation

   POST is used to create new resources on the server.

2. Step 2: Apply to batch create context

   Batch create sends multiple new items in one POST request.

3. Final Answer:

   POST -> Option B

4. Quick Check:

   Batch create uses POST [OK]

Hint: Batch create always uses POST method [OK]

Common Mistakes:

• Using GET which is for reading data
• Using DELETE which removes data
• Using PUT which replaces resources

2. Which of the following is the correct JSON format for sending multiple items in a batch create request body?

easy

A. {"name": "item1", "name": "item2"}

B. [{"name": "item1"}, {"name": "item2"}]

C. {"items": [{"name": "item1"}, {"name": "item2"}]}

D. {"item1": "name", "item2": "name"}

Solution

1. Step 1: Identify JSON array structure for batch data

   Batch create expects an object with a key containing an array of items.

2. Step 2: Match correct JSON format

   {"items": [{"name": "item1"}, {"name": "item2"}]} is a JSON object with an array of objects, which is correct for batch create.

3. Final Answer:

   {"items": [{"name": "item1"}, {"name": "item2"}]} -> Option C

4. Quick Check:

   Batch create body = JSON object with items array [OK]

Hint: Batch create body is a JSON object with an array of items [OK]

Common Mistakes:

• Using duplicate keys in one object
• Sending a single object instead of an array
• Using incorrect JSON syntax

3. Given this batch create endpoint code snippet, what will be the response if one item is invalid?

POST /items/batch
Request body: [{"name": "item1"}, {"name": ""}]

Response: 400 Bad Request
{
  "error": "Validation failed",
  "details": [{"index": 1, "message": "Name cannot be empty"}]
}

medium

A. Server crashes due to invalid input

B. All items are created, ignoring the invalid one

C. Only the valid items are created, error ignored

D. No items are created, and error details are returned

Solution

1. Step 1: Understand validation behavior in batch create

   If any item is invalid, the server should reject the whole batch to keep data consistent.

2. Step 2: Analyze the response code and message

   Response 400 with error details means no items were created and client is informed.

3. Final Answer:

   No items are created, and error details are returned -> Option D

4. Quick Check:

   Validation failure returns 400 with errors [OK]

Hint: Validation errors cause full batch rejection [OK]

Common Mistakes:

• Assuming partial success without error
• Ignoring error details in response
• Expecting server to crash on bad input

4. You wrote a batch create endpoint but clients report that sending an empty array causes a 500 Internal Server Error. What is the likely fix?

medium

A. Add validation to return 400 Bad Request if array is empty

B. Change HTTP method from POST to GET

C. Remove JSON parsing from the endpoint

D. Allow empty arrays and return 204 No Content

Solution

1. Step 1: Identify cause of 500 error on empty input

   Server likely crashes because it does not handle empty arrays properly.

2. Step 2: Implement input validation for empty arrays

   Return 400 Bad Request to inform client that empty batch is invalid.

3. Final Answer:

   Add validation to return 400 Bad Request if array is empty -> Option A

4. Quick Check:

   Validate input to avoid server errors [OK]

Hint: Validate empty input to prevent server errors [OK]

Common Mistakes:

• Ignoring empty input causing crashes
• Changing HTTP method incorrectly
• Skipping JSON parsing

5. You want to design a batch create endpoint that returns the ID of each created item and reports errors per item without failing the whole batch. Which response design is best?

hard

A. {"results": [{"id": 1, "status": "created"}, {"error": "Invalid name", "status": "failed"}]}

B. {"error": "Batch failed", "status": 400}

C. [{"id": 1}, {"id": 2}]

D. {"message": "All items created successfully"}

Solution

1. Step 1: Understand partial success reporting

   To report success or failure per item, response must include status and details for each.

2. Step 2: Match response format to requirements

   {"results": [{"id": 1, "status": "created"}, {"error": "Invalid name", "status": "failed"}]} provides per-item status and error messages, allowing partial success.

3. Final Answer:

   {"results": [{"id": 1, "status": "created"}, {"error": "Invalid name", "status": "failed"}]} -> Option A

4. Quick Check:

   Per-item status in response enables partial success [OK]

Hint: Return per-item status and errors in response [OK]

Common Mistakes:

• Failing whole batch on one error
• Returning only success without error info
• Using generic messages without details