Validation error responses in Spring Boot - Mini Project: Build & Apply

Handling Validation Error Responses in Spring Boot

📖 Scenario: You are building a simple Spring Boot REST API for user registration. You want to ensure that when users send invalid data, the API responds with clear validation error messages.

🎯 Goal: Create a Spring Boot controller that validates user input and returns structured validation error responses.

📋 What You'll Learn

Create a User class with validation annotations

Create a REST controller with a POST endpoint to accept User data

Add a configuration to handle validation errors and return a JSON response with error details

Ensure the error response contains field names and corresponding error messages

💡 Why This Matters

🌍 Real World

APIs often need to validate user input and provide clear error messages so clients can fix their requests.

💼 Career

Understanding validation and error handling is essential for backend developers building reliable and user-friendly APIs.

1

Create User class with validation annotations

Create a class called User with two fields: name of type String and email of type String. Add the annotation @NotBlank on name and @Email on email.

Spring Boot

public class User {
    // Your code here
}

Hint

Use @NotBlank on the name field and @Email on the email field.

2

Create REST controller with POST endpoint

Create a class called UserController annotated with @RestController. Add a POST mapping method called registerUser that accepts a @Valid @RequestBody User user parameter and returns ResponseEntity<String> with body "User registered".

Spring Boot

import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.http.ResponseEntity;
import jakarta.validation.Valid;

@RestController
public class UserController {
    // Your code here
}

Hint

Use @RestController on the class and @PostMapping("/register") on the method.

3

Create exception handler for validation errors

Create a class called ValidationExceptionHandler annotated with @RestControllerAdvice. Add a method called handleMethodArgumentNotValid that takes MethodArgumentNotValidException ex and returns a Map<String, String> of field errors. Use ex.getBindingResult().getFieldErrors() to collect field names and default messages into the map.

Spring Boot

import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.MethodArgumentNotValidException;
import java.util.Map;
import java.util.HashMap;

@RestControllerAdvice
public class ValidationExceptionHandler {
    // Your code here
}

Hint

Use @RestControllerAdvice and @ExceptionHandler(MethodArgumentNotValidException.class) to catch validation errors.

4

Complete the project with proper imports and class structure

Ensure all classes have the necessary imports and are in the same package or properly imported. Confirm that the User, UserController, and ValidationExceptionHandler classes are complete and ready to run in a Spring Boot application.

Spring Boot

/* All classes and imports are present above. 
   Review and add any missing imports or annotations here. */
// Your code here

Hint

Make sure all classes are in the same package and have all required imports.

Practice

1. What is the main purpose of validation error responses in a Spring Boot application?

easy

A. To speed up the application startup time

B. To inform users about incorrect input so they can fix it

C. To log errors only for developers without user feedback

D. To automatically correct user input without notification

Solution

1. Step 1: Understand validation error responses

   Validation error responses are designed to tell users what input is wrong so they can correct it.

2. Step 2: Identify the purpose in Spring Boot context

   Spring Boot uses validation error responses to provide clear feedback to users, improving user experience.

3. Final Answer:

   To inform users about incorrect input so they can fix it -> Option B

4. Quick Check:

   Validation error responses = user input feedback [OK]

Hint: Validation errors help users fix input mistakes [OK]

Common Mistakes:

• Thinking validation errors speed up startup
• Assuming errors are only for developer logs
• Believing errors auto-correct input silently

2. Which annotation is used in Spring Boot to trigger validation on a request body object?

easy

A. @Valid

B. @Autowired

C. @RequestBody

D. @Controller

Solution

1. Step 1: Identify annotation for validation

   The @Valid annotation tells Spring Boot to validate the object passed in the request.

2. Step 2: Differentiate from other annotations

   @RequestBody binds the request body, @Autowired injects dependencies, and @Controller marks a class as a controller, none trigger validation.

3. Final Answer:

   @Valid -> Option A

4. Quick Check:

   Validation trigger = @Valid [OK]

Hint: Use @Valid to activate validation on input objects [OK]

Common Mistakes:

• Confusing @RequestBody with validation trigger
• Using @Autowired for validation incorrectly
• Thinking @Controller triggers validation

3. Given this Spring Boot controller method snippet, what will be the HTTP response status if validation fails?

@PostMapping("/users")
public ResponseEntity<String> createUser(@Valid @RequestBody User user) {
    return ResponseEntity.ok("User created");
}

medium

A. 400 Bad Request

B. 200 OK

C. 500 Internal Server Error

D. 404 Not Found

Solution

1. Step 1: Understand validation failure behavior

   When validation fails on a @Valid annotated object, Spring Boot returns a 400 Bad Request by default.

2. Step 2: Check the method response

   The method returns 200 OK only if validation passes; failure triggers automatic 400 response.

3. Final Answer:

   400 Bad Request -> Option A

4. Quick Check:

   Validation fail status = 400 Bad Request [OK]

Hint: Validation failure returns 400 Bad Request by default [OK]

Common Mistakes:

• Assuming 200 OK even if validation fails
• Thinking validation failure causes 500 error
• Confusing 404 Not Found with validation errors

4. What is wrong with this Spring Boot exception handler for validation errors?

@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<String> handleValidationError(MethodArgumentNotValidException ex) {
    return ResponseEntity.badRequest().body(ex.getMessage());
}

medium

A. It does not use @Valid annotation

B. It uses the wrong exception class for validation errors

C. It should return HTTP status 500 instead of 400

D. It returns a plain message string instead of detailed field errors

Solution

1. Step 1: Analyze the exception handler response

   The handler returns only the exception message string, which is not user-friendly or field-specific.

2. Step 2: Understand best practice for validation errors

   Best practice is to return a JSON with detailed field error messages for clarity, not just a plain string.

3. Final Answer:

   It returns a plain message string instead of detailed field errors -> Option D

4. Quick Check:

   Validation error response should be detailed JSON [OK]

Hint: Return detailed JSON, not plain strings, for validation errors [OK]

Common Mistakes:

• Using wrong exception class (MethodArgumentNotValidException is correct)
• Returning HTTP 500 instead of 400
• Confusing @Valid usage with exception handling

5. You want to customize validation error responses to return JSON with field names and messages. Which approach correctly achieves this in Spring Boot?

hard

A. Use @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) on the controller method to handle validation errors

B. Add @Valid to the controller method and rely on default error messages without customization

C. Create a @ControllerAdvice class with @ExceptionHandler for MethodArgumentNotValidException that extracts field errors and returns a JSON map

D. Catch Exception in the controller method and return a plain string message

Solution

1. Step 1: Understand how to customize validation error responses

   Using a @ControllerAdvice with an @ExceptionHandler for MethodArgumentNotValidException allows extracting field errors and returning custom JSON.

2. Step 2: Evaluate other options

   Add @Valid to the controller method and rely on default error messages without customization uses default messages without customization; C uses wrong status; D returns plain string, not JSON.

3. Final Answer:

   Create a @ControllerAdvice class with @ExceptionHandler for MethodArgumentNotValidException that extracts field errors and returns a JSON map -> Option C

4. Quick Check:

   Custom JSON errors = @ControllerAdvice + @ExceptionHandler [OK]

Hint: Use @ControllerAdvice and @ExceptionHandler for custom JSON errors [OK]

Common Mistakes:

• Relying on default messages without customization
• Using wrong HTTP status for validation errors
• Returning plain strings instead of JSON