Saturday, March 25, 2023
HomeJavaThe right way to return totally different HTTP standing code from a...

The right way to return totally different HTTP standing code from a Spring MVC controller? Instance Tutorial

Hi there guys, if you’re questioning easy methods to return totally different HTTP Standing codes
from a Spring MVC controlle
r then you’ve got come to the appropriate place. You may
use @ResponseCode annotation
on Spring MVC to ship totally different HTTP codes to the shopper as a part of the HTTP
response. If you’re growing REST APIs then you possibly can even
to try this job. This text will show easy methods to return totally different HTTP
statuses for a Spring MVC controller. Previous to implementation, all we have to
perceive what’s with the HTTP return sorts and why we want them. Let’s have
a fast look into this.

As a developer, all you’ll want to perceive is that it’s essential to give a greater
expertise to customers of your system for higher interplay. Letting different
builders know, why the error occurs within the code is a greatest observe that’s
used to develop well-organized software program. 

Builders that use your service can work extra effectively as a result of the probabilities
of failure are lowered. That is the place HTTP standing codes come into play, alongside
with a quick message within the physique of the response that explains what is going on

What are widespread HTTP Codes for Net Builders?

Merely the HTTP code consists of three digits that include the response of HTTP
request. From the primary digit of three digits, we are able to determine the kind of
response of HTTP requests. 

Informational (Begins with digit 1 ex- 1XX) – The request is acquired
and the method is continuous. Alerts the sender to attend for the ultimate

Profitable (Begins with digit 2 ex- 2XX) – The request was efficiently
acquired and accepted.

Redirection ( Begins with 3 ex – 3XX) – The request was efficiently
acquired however wants to finish additional motion to finish the request.

Shopper Error (Begins with 4 ex – 4XX) – The shopper is the one who trigger
the error and must be mounted to ship the request.

Server Error (Begins with 5 ex – 5XX) – The error was attributable to the

Returning standing code with @ResponseStatus – Instance

Spring Framework helps us out by offering an enum that incorporates the entire
HTTP standing codes. It is a versatile annotation which may be utilized in controllers
on the class or technique stage, on Customized Exception Courses, and on
@ControllerAdvice courses.

On this technique, we use the
@ResponseBody annotation
in each instances. When used on the class stage, all class strategies will end in
a response with the required HTTP standing code. All technique which is annotated
with the
@ResponseStatus(code = HttpStatus.OK, motive = “OK”) doesn’t return an error code and solely will return the 200 standing code
by default.
public class StudentController {

@ResponseStatus(code = HttpStatus.OK, motive = "OK")
public String okay() {
return "Class Degree HTTP Standing Overriden. The HTTP Standing can be OK (CODE 200)n";

public String serviceUnavailable() {
return "The HTTP Standing can be SERVICE_UNAVAILABLE (CODE 503)n";


As per this instance, Spring Fremework will reply with a 406 Code if it
receives a
GET request
to “/technique” URL.

Returning standing code with an Exception.

Now, let’s have a look at one other instance of a controller technique to return HTTP standing
in case of an error or exception. To show this, we’ll add the
second technique to the controller to point out easy methods to use an exception
to return a standing code.

@RequestMapping(worth = "/exception", technique = RequestMethod.GET)
public ResponseEntity sendViaException() {
throw new ForbiddenException();

If the GET request will come to the
“/exception” URL path then it’ll throw a ForbiddenException and it’ll separate the category. 


That is all about easy methods to return totally different HTTP standing codes from a Spring MVC
. This is a vital idea which each and every Java developer needs to be
acquainted with. Simply to recap, Spring Frameworks supplies a number of methods to return customized standing codes from its Controller courses like you need to use a ResponseEntity@ResponseStatus annotation on exception courses, and through the use of the @ControllerAdvice and @ExceptionHandler annotations. So on this tutorial, we mentioned the totally different HTTP
statuses for a Spring MVC controller. See you within the subsequent tutorial.

 Different Spring Framework articles you could prefer to discover 

Thanks for studying this text up to now. If you happen to discover this Spring MVC tutorial
and HTTP standing code
instance helpful, please share them with your pals and
colleagues. When you have any questions or suggestions, then please drop a
be aware.   



Please enter your comment!
Please enter your name here

Most Popular

Recent Comments