Spring Boot Rest Controller how to return different HTTP status codes

Question

I am using Spring Boot for a simple REST API and would like to return a correct HTTP statuscode if something fails      RequestMapping value   rawdata    method   RequestMethod PUT    ResponseBody   ResponseStatus  HttpStatus OK    public RestModel create  RequestBody String data            code ommitted           how do i return a correct status code if something fails          Being new to Spring and Spring Boot  the basic question is how do i return different status codes when something is ok or fails

User · Answer

In case you want to return a custom defined status code, you can use the ResponseEntity as here:

@RequestMapping(value="/rawdata/", method = RequestMethod.PUT)
public ResponseEntity<?> create(@RequestBody String data) {
    int customHttpStatusValue = 499;
    Foo foo = bar();
    return ResponseEntity.status(customHttpStatusValue).body(foo);
}

The CustomHttpStatusValue could be any integer within or outside of standard HTTP Status Codes.

User · Answer

There are different ways to return status code  1   RestController class should extends BaseRest class  in BaseRest class we can handle exception and return expected error codes  for example    RestController  RequestMapping class RestController extends BaseRest       ControllerAdvice public class BaseRest    ExceptionHandler  Exception class            ResponseStatus value HttpStatus INTERNAL SERVER ERROR      public ErrorModel genericError HttpServletRequest request               HttpServletResponse response  Exception exception                     ErrorModel error   new ErrorModel            resource addError  quot error code quot   exception getLocalizedMessage             return error

User · Answer

There are several options you can use  Quite good way is to use exceptions and class for handling called  ControllerAdvice    ControllerAdvice class GlobalControllerExceptionHandler        ResponseStatus HttpStatus CONFLICT      409      ExceptionHandler DataIntegrityViolationException class      public void handleConflict                Nothing to do           Also you can pass HttpServletResponse to controller method and just set response code   public RestModel create  RequestBody String data  HttpServletResponse response           response committed        response setStatus HttpServletResponse SC ACCEPTED       Please refer to the this great blog post for details  Exception Handling in Spring MVC    NOTE  In Spring MVC using  ResponseBody annotation is redundant - it s already included in  RestController annotation

User · Answer

Try this code    RequestMapping value     validate   method   RequestMethod GET  produces    application json   public ResponseEntity lt ErrorBean gt  validateUser  QueryParam  jsonInput   final String jsonInput        int numberHTTPDesired   400      ErrorBean responseBean   new ErrorBean        responseBean setError  ERROR        responseBean setMensaje  Error in validation          return new ResponseEntity lt ErrorBean gt  responseBean  HttpStatus valueOf numberHTTPDesired

User · Answer

One of the way to do this is you can use ResponseEntity as a return object    RequestMapping value   rawdata    method   RequestMethod PUT   public ResponseEntity lt   gt  create  RequestBody String data     if everything fine      return new ResponseEntity lt  gt  RestModel  HttpStatus OK   else     return new ResponseEntity lt  gt  null  HttpStatus INTERNAL SERVER ERROR

User · Answer

A nice way is to use Spring s ResponseStatusException Rather than returning a ResponseEntityor similar you simply throw the ResponseStatusException from the controller with an HttpStatus and cause  for example  throw new ResponseStatusException HttpStatus BAD REQUEST   quot Cause description here quot     or  throw new ResponseStatusException HttpStatus INTERNAL SERVER ERROR   quot Cause description here quot     This results in a response to the client containing the HTTP status  e g  400 Bad request  with a body like       quot timestamp quot    quot 2020-07-09T04 43 04 695 0000 quot      quot status quot   400     quot error quot    quot Bad Request quot      quot message quot    quot Cause description here quot      quot path quot    quot  test-api v1 search quot

[spring] Spring Boot Rest Controller how to return different HTTP status codes?

Examples related to spring

Examples related to rest

Examples related to spring-boot

Examples related to http-status-code-415