@RequestBody for JSON input in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does the @RequestBody annotation do in Spring Boot?

It tells Spring Boot to take the JSON data from the HTTP request body and convert it into a Java object automatically.

beginner

How does Spring Boot convert JSON data into a Java object when using @RequestBody?

Spring Boot uses a message converter (like Jackson) to map JSON fields to the Java object's fields based on matching names.

intermediate

What happens if the JSON sent to a Spring Boot controller with @RequestBody is missing a required field?

Spring Boot will try to create the object but missing fields will be null or default values. Validation annotations can be used to check required fields.

intermediate

Can @RequestBody be used with other content types besides JSON?

Yes, but JSON is the most common. Spring Boot supports XML and other formats if configured with the right converters.

beginner

Why is @RequestBody important for REST APIs in Spring Boot?

It simplifies receiving complex data from clients by automatically converting JSON into Java objects, making code cleaner and easier to maintain.

What does @RequestBody do in a Spring Boot controller method?

A Maps JSON from the request body to a Java object

B Maps URL parameters to method arguments

C Sends JSON response to the client

D Handles form data submission

@RequestBody reads JSON from the HTTP request body and converts it into a Java object.

Which library does Spring Boot commonly use to convert JSON to Java objects with @RequestBody?

A Jackson

B Hibernate

C JUnit

D Log4j

Jackson is the default JSON processor used by Spring Boot for converting JSON to Java objects.

If the JSON sent to a @RequestBody parameter is invalid, what will happen?

A The JSON is saved as a string

B Spring Boot ignores the error and continues

C Spring Boot throws an error and returns a 400 Bad Request

D The server crashes

Invalid JSON causes Spring Boot to return a 400 Bad Request error automatically.

Can @RequestBody be used to read XML data by default?

A No, it only reads plain text

B No, only JSON is supported by default

C Yes, always

D Yes, if the right converter is configured

Spring Boot can read XML with @RequestBody if an XML message converter is added.

Which HTTP method is commonly used with @RequestBody to send JSON data?

A GET

B POST

C DELETE

D HEAD

POST requests usually send JSON data in the body, which @RequestBody reads.

Explain how @RequestBody works in Spring Boot when receiving JSON data.

Think about how JSON data from a client becomes a Java object automatically.

Describe a common error scenario when using @RequestBody and how Spring Boot handles it.

Consider what happens if the client sends broken JSON.

Practice

1. What is the main purpose of the @RequestBody annotation in a Spring Boot controller?

easy

A. To validate form data submitted via GET requests

B. To send JSON data back in the HTTP response

C. To map URL query parameters to method arguments

D. To automatically convert JSON from the HTTP request body into a Java object

Solution

1. Step 1: Understand the role of @RequestBody

   @RequestBody tells Spring Boot to take JSON data sent in the HTTP request body and convert it into a Java object automatically.

2. Step 2: Differentiate from other annotations

   It does not handle response data (that's @ResponseBody), nor does it map query parameters or validate GET form data.

3. Final Answer:

   To automatically convert JSON from the HTTP request body into a Java object -> Option D

4. Quick Check:

   @RequestBody = JSON to Java object [OK]

Hint: Remember: @RequestBody reads JSON input from request body [OK]

Common Mistakes:

• Confusing @RequestBody with @ResponseBody
• Thinking it maps URL parameters
• Assuming it validates data automatically

2. Which of the following method signatures correctly uses @RequestBody to accept a JSON object representing a User in a Spring Boot controller?

easy

A. public ResponseEntity<String> addUser(@RequestBody User user)

B. public ResponseEntity<String> addUser(@RequestParam User user)

C. public ResponseEntity<String> addUser(@PathVariable User user)

D. public ResponseEntity<String> addUser(User user)

Solution

1. Step 1: Identify correct annotation for JSON body

   @RequestBody is required to tell Spring Boot to convert JSON in the request body to a User object.

2. Step 2: Check other annotations

   @RequestParam reads query parameters, @PathVariable reads URL path segments, and no annotation means no automatic JSON conversion.

3. Final Answer:

   public ResponseEntity<String> addUser(@RequestBody User user) -> Option A

4. Quick Check:

   JSON input needs @RequestBody [OK]

Hint: Use @RequestBody for JSON input, not @RequestParam or @PathVariable [OK]

Common Mistakes:

• Using @RequestParam instead of @RequestBody
• Forgetting @RequestBody annotation
• Confusing @PathVariable with JSON input

3. Given the following controller method:

  @PostMapping("/add")
  public String addUser(@RequestBody User user) {
    return "Hello " + user.getName();
  }

And the JSON sent in the request body is:

{"name": "Alice"}

What will be the response?

medium

A. HTTP 400 Bad Request

B. "Hello null"

C. "Hello Alice"

D. Compilation error

Solution

1. Step 1: Understand JSON to Java object mapping

   The JSON {"name": "Alice"} maps to a User object with name set to "Alice".

2. Step 2: Check method return value

   The method returns "Hello " + user.getName(), so it returns "Hello Alice".

3. Final Answer:

   "Hello Alice" -> Option C

4. Quick Check:

   JSON name maps to user.getName() = "Hello Alice" [OK]

Hint: JSON keys map to object fields, so output uses those values [OK]

Common Mistakes:

• Assuming user.getName() is null
• Expecting HTTP error without malformed JSON
• Confusing request body with query parameters

4. Consider this controller method:

@PostMapping("/user")
public String createUser(@RequestBody User user) {
  return user.getEmail();
}

If the client sends an empty request body, what will happen?

medium

A. Spring Boot throws an HTTP 400 Bad Request error

B. The method returns null

C. The method returns an empty string

D. Compilation error due to missing @RequestBody

Solution

1. Step 1: Check behavior with empty JSON body

   When @RequestBody expects JSON but receives empty body, Spring Boot cannot create the User object.

2. Step 2: Understand Spring Boot error handling

   Spring Boot responds with HTTP 400 Bad Request for missing or malformed JSON input.

3. Final Answer:

   Spring Boot throws an HTTP 400 Bad Request error -> Option A

4. Quick Check:

   Empty JSON body causes HTTP 400 error [OK]

Hint: Empty JSON body with @RequestBody causes HTTP 400 error [OK]

Common Mistakes:

• Assuming method returns null or empty string
• Thinking compilation error occurs
• Ignoring HTTP error on missing JSON

5. You want to create a Spring Boot REST endpoint that accepts a JSON array of User objects in the request body and returns the count of users received. Which method signature correctly uses @RequestBody to achieve this?

hard

A. public int countUsers(@RequestBody User user)

B. public int countUsers(@RequestBody List<User> users)

C. public int countUsers(@RequestParam List<User> users)

D. public int countUsers(@PathVariable List<User> users)

Solution

1. Step 1: Identify correct parameter type for JSON array

   To accept a JSON array of User objects, the method parameter should be a List<User> annotated with @RequestBody.

2. Step 2: Exclude incorrect annotations and types

   @RequestParam and @PathVariable do not handle JSON body. Single User parameter cannot accept an array.

3. Final Answer:

   public int countUsers(@RequestBody List<User> users) -> Option B

4. Quick Check:

   JSON array maps to List<User> with @RequestBody [OK]

Hint: Use List<User> with @RequestBody for JSON arrays [OK]

Common Mistakes:

• Using single User instead of List<User>
• Using @RequestParam or @PathVariable for JSON body
• Forgetting @RequestBody annotation