Java Community | Help. Code. Learn.•12mo ago

How to apply request body validation with error details?

Hello there,
I want to apply request body validation to my Spring project

import jakarta.validation.constraints.*;

data class RequestBodyDTO(
    @NotBlank(message = "ID is required.")
    val iD: String
)

import jakarta.validation.constraints.*;

data class RequestBodyDTO(
    @NotBlank(message = "ID is required.")
    val iD: String
)

import jakarta.validation.constraints.*;

data class RequestBodyDTO(
    @NotBlank(message = "ID is required.")
    val iD: String
)

import jakarta.validation.constraints.*;

data class RequestBodyDTO(
    @NotBlank(message = "ID is required.")
    val iD: String
)

and this endpoint

import jakarta.validation.Valid
import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.*

@RestController()
@RequestMapping("/foo")
class Handler {
    @PostMapping
    fun handle(@Valid @RequestBody requestBody: RequestBodyDTO): ResponseEntity<Unit> {
        return ResponseEntity.ok().build()
    }
}

import jakarta.validation.Valid
import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.*

@RestController()
@RequestMapping("/foo")
class Handler {
    @PostMapping
    fun handle(@Valid @RequestBody requestBody: RequestBodyDTO): ResponseEntity<Unit> {
        return ResponseEntity.ok().build()
    }
}

import jakarta.validation.Valid
import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.*

@RestController()
@RequestMapping("/foo")
class Handler {
    @PostMapping
    fun handle(@Valid @RequestBody requestBody: RequestBodyDTO): ResponseEntity<Unit> {
        return ResponseEntity.ok().build()
    }
}

import jakarta.validation.Valid
import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.*

@RestController()
@RequestMapping("/foo")
class Handler {
    @PostMapping
    fun handle(@Valid @RequestBody requestBody: RequestBodyDTO): ResponseEntity<Unit> {
        return ResponseEntity.ok().build()
    }
}

I thought

@Valid

@Valid

@Valid

@Valid would handle it for me but actually the API consumer still gets a 400 without any error details. So the consumer doesn't know what's wrong.

After googling around I think Spring doesn't do that for me out of the box. So I created an additional class

import org.springframework.http.HttpStatus
import org.springframework.validation.FieldError
import org.springframework.web.bind.MethodArgumentNotValidException
import org.springframework.web.bind.annotation.*

@ControllerAdvice
class ValidationExceptionHandler {
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(MethodArgumentNotValidException::class)
    fun handleValidationException(
        exception: MethodArgumentNotValidException
    ): Map<String, String?> {
        return exception.bindingResult.allErrors.associate { error ->
            val fieldName = (error as FieldError).field
            val errorMessage = error.defaultMessage

            fieldName to errorMessage
        }
    }
}

import org.springframework.http.HttpStatus
import org.springframework.validation.FieldError
import org.springframework.web.bind.MethodArgumentNotValidException
import org.springframework.web.bind.annotation.*

@ControllerAdvice
class ValidationExceptionHandler {
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(MethodArgumentNotValidException::class)
    fun handleValidationException(
        exception: MethodArgumentNotValidException
    ): Map<String, String?> {
        return exception.bindingResult.allErrors.associate { error ->
            val fieldName = (error as FieldError).field
            val errorMessage = error.defaultMessage

            fieldName to errorMessage
        }
    }
}

import org.springframework.http.HttpStatus
import org.springframework.validation.FieldError
import org.springframework.web.bind.MethodArgumentNotValidException
import org.springframework.web.bind.annotation.*

@ControllerAdvice
class ValidationExceptionHandler {
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(MethodArgumentNotValidException::class)
    fun handleValidationException(
        exception: MethodArgumentNotValidException
    ): Map<String, String?> {
        return exception.bindingResult.allErrors.associate { error ->
            val fieldName = (error as FieldError).field
            val errorMessage = error.defaultMessage

            fieldName to errorMessage
        }
    }
}

import org.springframework.http.HttpStatus
import org.springframework.validation.FieldError
import org.springframework.web.bind.MethodArgumentNotValidException
import org.springframework.web.bind.annotation.*

@ControllerAdvice
class ValidationExceptionHandler {
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(MethodArgumentNotValidException::class)
    fun handleValidationException(
        exception: MethodArgumentNotValidException
    ): Map<String, String?> {
        return exception.bindingResult.allErrors.associate { error ->
            val fieldName = (error as FieldError).field
            val errorMessage = error.defaultMessage

            fieldName to errorMessage
        }
    }
}

Unfortunately the result is the same, the API consumer won't get any error details. Is something missing? Do I even need the

ValidationExceptionHandler

ValidationExceptionHandler

ValidationExceptionHandler

ValidationExceptionHandler ? How do I achieve this?

Thanks!

JavaBot•1/12/25, 4:54 PM

⌛⌛ This post has been reserved for your question.

Hey @Garzec! Please use
/close
/close
or the Close PostClose Post button above when your problem is solved. Please remember to follow the help guidelines. This post will be automatically marked as dormant after 300 minutes of inactivity.

TIP: Narrow down your issue to simple and precise questions to maximize the chance that others will reply in here.

ayylmao123xdd•1/12/25, 5:06 PM

you can create a class that sums up all the validation errors and return it to the consumer

ayylmao123xdd•1/12/25, 5:06 PM

so you get something like
"error_message": "ID is required."

ayylmao123xdd•1/12/25, 5:06 PM

which is basically something that ur trying to do

ayylmao123xdd•1/12/25, 5:07 PM

also try using @RestControllerAdvice

Aayylmao123xdd you can create a class that sums up all the validation errors and return it to t...

GarzecOP•1/12/25, 5:08 PM

would you mind telling me how to do this?

ValidationExceptionHandler

ValidationExceptionHandler

is wrong?

GGarzec would you mind telling me how to do this? `ValidationExceptionHandler` is wrong?

ayylmao123xdd•1/12/25, 5:11 PM

https://www.bezkoder.com/spring-boot-restcontrolleradvice/
you can check here how they do it

BezKoder

@RestControllerAdvice example in Spring Boot - BezKoder

In this tutorial, we’re gonna look at an Spring Boot example that uses @RestControllerAdvice for exception handling in Restful API. I also show you the comparison between @RestControllerAdvice and @ControllerAdvice along with the use of @ExceptionHandler annotation. Related Posts: – @RestController vs @Controller – Spring Boot, Spring Data JPA –...

ayylmao123xdd•1/12/25, 5:11 PM

and no its not wrong

ayylmao123xdd•1/12/25, 5:12 PM

 @ExceptionHandler(value = {ResourceNotFoundException.class, CertainException.class})
  @ResponseStatus(value = HttpStatus.NOT_FOUND)
  public ErrorMessage resourceNotFoundException(ResourceNotFoundException ex, WebRequest request) {
    ErrorMessage message = new ErrorMessage(
        status,
        date,
        ex.getMessage(),
        description);
    
    return message;
  }

 @ExceptionHandler(value = {ResourceNotFoundException.class, CertainException.class})
  @ResponseStatus(value = HttpStatus.NOT_FOUND)
  public ErrorMessage resourceNotFoundException(ResourceNotFoundException ex, WebRequest request) {
    ErrorMessage message = new ErrorMessage(
        status,
        date,
        ex.getMessage(),
        description);
    
    return message;
  }

ayylmao123xdd•1/12/25, 5:12 PM

from that site

ayylmao123xdd•1/12/25, 5:13 PM

and that class error message will be returned to the client

ayylmao123xdd•1/12/25, 5:13 PM

but yea first swap to rest controller advice

GarzecOP•1/12/25, 5:46 PM

@ayylmao123xdd thank you. I tried to follow the blog post and just changed from @ControllerAdvice@ControllerAdvice to @RestControllerAdvice@RestControllerAdvice since ErrorMessageErrorMessage is just a custom type, I want to make use of problem details later on

Still, doesn't work

GGarzec @ayylmao123xdd thank you. I tried to follow the blog post and just changed from ...

JavaBot•1/12/25, 5:46 PM

If you are finished with your post, please close it.
If you are not, please ignore this message.
Note that you will not be able to send further messages here after this post have been closed but you will be able to create new posts.

ayylmao123xdd•1/12/25, 5:50 PM

yes you need to create a custom class

ayylmao123xdd•1/12/25, 5:51 PM

and it will return that class when an error happens

Aayylmao123xdd and it will return that class when an error happens

GarzecOP•1/12/25, 6:11 PM

you mean like so?

import org.springframework.http.HttpStatus
import org.springframework.validation.FieldError
import org.springframework.web.bind.MethodArgumentNotValidException
import org.springframework.web.bind.annotation.ExceptionHandler
import org.springframework.web.bind.annotation.ResponseStatus
import org.springframework.web.bind.annotation.RestControllerAdvice

@RestControllerAdvice
class ValidationExceptionHandler {
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(MethodArgumentNotValidException::class)
    fun handleValidationException(
        exception: MethodArgumentNotValidException
    ): ValidationErrorResponse {
        val fieldErrors = exception.bindingResult.allErrors.associate { error ->
            val fieldName = (error as FieldError).field
            val errorMessage = error.defaultMessage

            fieldName to errorMessage
        }

        return ValidationErrorResponse(fieldErrors)
    }
}

data class ValidationErrorResponse(val fieldErrors: Map<String, String?>)

import org.springframework.http.HttpStatus
import org.springframework.validation.FieldError
import org.springframework.web.bind.MethodArgumentNotValidException
import org.springframework.web.bind.annotation.ExceptionHandler
import org.springframework.web.bind.annotation.ResponseStatus
import org.springframework.web.bind.annotation.RestControllerAdvice

@RestControllerAdvice
class ValidationExceptionHandler {
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(MethodArgumentNotValidException::class)
    fun handleValidationException(
        exception: MethodArgumentNotValidException
    ): ValidationErrorResponse {
        val fieldErrors = exception.bindingResult.allErrors.associate { error ->
            val fieldName = (error as FieldError).field
            val errorMessage = error.defaultMessage

            fieldName to errorMessage
        }

        return ValidationErrorResponse(fieldErrors)
    }
}

data class ValidationErrorResponse(val fieldErrors: Map<String, String?>)

That still doesn't work

ayylmao123xdd•1/12/25, 6:12 PM

so what happens

ayylmao123xdd•1/12/25, 6:12 PM

when the id is invalid

GarzecOP•1/12/25, 6:12 PM

nothing, when I set a breakpoint, it won't run the function

ayylmao123xdd•1/12/25, 6:12 PM

but what happens when the id is invalid

ayylmao123xdd•1/12/25, 6:12 PM

does it return the full stacktrace

GarzecOP•1/12/25, 6:12 PM

you only get a 400 with

{
    "timestamp": "2025-01-12T18:11:01.102+00:00",
    "path": "/foo",
    "status": 400,
    "error": "Bad Request",
    "requestId": "2e927c69-2"
}

{
    "timestamp": "2025-01-12T18:11:01.102+00:00",
    "path": "/foo",
    "status": 400,
    "error": "Bad Request",
    "requestId": "2e927c69-2"
}

ayylmao123xdd•1/12/25, 6:12 PM

and you want the

ayylmao123xdd•1/12/25, 6:13 PM

"ID is required"

ayylmao123xdd•1/12/25, 6:13 PM

right

GarzecOP•1/12/25, 6:13 PM

yes please

ayylmao123xdd•1/12/25, 6:13 PM

exception.getFieldErrors().forEach(fieldError ->
                validationError.addViolation(fieldError.getField(), fieldError.getDefaultMessage()));

exception.getFieldErrors().forEach(fieldError ->
                validationError.addViolation(fieldError.getField(), fieldError.getDefaultMessage()));

ayylmao123xdd•1/12/25, 6:13 PM

you can do something like this

ayylmao123xdd•1/12/25, 6:13 PM

basically

ayylmao123xdd•1/12/25, 6:13 PM

in that method argument not valid exception

ayylmao123xdd•1/12/25, 6:14 PM

you run the get field errors

ayylmao123xdd•1/12/25, 6:14 PM

and just add it to a lsit

GarzecOP•1/12/25, 6:14 PM

sorry, the function handleValidationExceptionhandleValidationException never runs

GarzecOP•1/12/25, 6:15 PM

if /foo/foo is valid, it executes the rest handler, if it's invalid then Spring responds with a 400, so handleValidationExceptionhandleValidationException never runs

GGarzec you only get a 400 with ``` { "timestamp": "2025-01-12T18:11:01.102+00:00",...

ayylmao123xdd•1/12/25, 6:18 PM

but it returns this

ayylmao123xdd•1/12/25, 6:18 PM

change the response status to maybe

ayylmao123xdd•1/12/25, 6:18 PM

not found

GarzecOP•1/12/25, 6:18 PM

yes, the default Spring behavior for invalid request bodies I guess

ayylmao123xdd•1/12/25, 6:18 PM

and see if that changes anything

ayylmao123xdd•1/12/25, 6:18 PM

 @ResponseStatus(HttpStatus.NOT_FOUND)

 @ResponseStatus(HttpStatus.NOT_FOUND)

ayylmao123xdd•1/12/25, 6:18 PM

set to this

ayylmao123xdd•1/12/25, 6:19 PM

and see if it changes the error code

ayylmao123xdd•1/12/25, 6:19 PM

should be 404 instead of 400

GarzecOP•1/12/25, 6:21 PM

no, same for INTERNAL_SERVER_ERRORINTERNAL_SERVER_ERROR

Is there some Spring magic required? Do I have to place this exception handler file into a specific directory with a conventional name or so...

ayylmao123xdd•1/12/25, 6:25 PM

hmmmmmmmm

ayylmao123xdd•1/12/25, 6:26 PM

@RestControllerAdvice
public class CustomExceptionHandler {
    @ExceptionHandler({yourerrorhere.class})
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public ErrorHandler handleNotFoundExceptions(RuntimeException exception) {
        return new ErrorHandler(exception.getMessage());
    }

@Getter
@RequiredArgsConstructor
public class ErrorHandler {
    private final String message;
}

@RestControllerAdvice
public class CustomExceptionHandler {
    @ExceptionHandler({yourerrorhere.class})
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public ErrorHandler handleNotFoundExceptions(RuntimeException exception) {
        return new ErrorHandler(exception.getMessage());
    }

@Getter
@RequiredArgsConstructor
public class ErrorHandler {
    private final String message;
}

ayylmao123xdd•1/12/25, 6:26 PM

can you try doing something like this

ayylmao123xdd•1/12/25, 6:26 PM

errorhandler is a separate class

How to apply request body validation with error details?

Similar Threads

Similar Threads

Similar Threads