code and
reason that should be returned.
The status code is applied to the HTTP response when the handler
method is invoked, but does not override status information set by other
means, such as ResponseEntity or "redirect:".
Warning
when using this annotation on an exception
class, or when setting the reason attribute of this annotation,
the HttpServletResponse.sendError method will be used.
With HttpServletResponse.sendError, the response is considered
complete and should not be written to any further. Furthermore, the Servlet
container will typically write an HTML error page therefore making the
use of a reason unsuitable for REST APIs. For such cases it is
preferable to use a org. as
a return type and avoid the use of @ResponseStatus altogether.
Note that a controller class may also be annotated with
@ResponseStatus which is then inherited by all @RequestMapping
and @ExceptionHandler methods in that class and its subclasses unless
overridden by a local @ResponseStatus declaration on the method.
org.springframework.web.servlet.mvc.annotation.ResponseStatusExceptionResolver , jakarta.servlet.http.HttpServletResponse#sendError(int, String)
| Modifier and Type | Method and Description |
|---|---|
| public HttpStatus | |
| public String | |
| public HttpStatus |
| code | back to summary |
|---|---|
| public HttpStatus code() The status code to use for the response. Default is
| |
| reason | back to summary |
|---|---|
| public String reason() The reason to be used for the response. Defaults to an empty string which will be ignored. Set the reason to a non-empty value to have it used to send a Servlet container error page. In this case, the return value of the handler method will be ignored. | |
| value | back to summary |
|---|---|
| public HttpStatus value() Alias for
| |