Returning different status codes in Spring Boot

Introduction

We use different status codes to tell the user or client what happened with their request. It helps them understand if it worked, failed, or needs more action.

When you want to confirm a successful request with a 200 OK status.

When a requested resource is not found and you want to send a 404 Not Found.

When a client sends bad data and you want to respond with 400 Bad Request.

When a new resource is created and you want to send 201 Created.

When the user is not authorized and you want to send 401 Unauthorized.

Syntax

Spring Boot

return new ResponseEntity<>(body, HttpStatus.STATUS_CODE);

Use ResponseEntity to customize the HTTP status code and response body.

Common status codes include HttpStatus.OK, HttpStatus.NOT_FOUND, HttpStatus.BAD_REQUEST, HttpStatus.CREATED, and HttpStatus.UNAUTHORIZED.

Examples

Sends a 200 OK status with a simple success message.

Spring Boot

return new ResponseEntity<>("Success", HttpStatus.OK);

Sends a 404 Not Found status with a message.

Spring Boot

return new ResponseEntity<>("Not Found", HttpStatus.NOT_FOUND);

Sends a 201 Created status after creating a resource.

Spring Boot

return new ResponseEntity<>("Created", HttpStatus.CREATED);

Sample Program

This Spring Boot controller returns different status codes based on the item ID. It shows how to send 200 OK, 201 Created, 400 Bad Request, and 404 Not Found.

Spring Boot

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class StatusCodeController {

    @GetMapping("/item/{id}")
    public ResponseEntity<String> getItem(@PathVariable int id) {
        if (id == 1) {
            return new ResponseEntity<>("Item found", HttpStatus.OK);
        } else if (id == 2) {
            return new ResponseEntity<>("Item created", HttpStatus.CREATED);
        } else if (id == 3) {
            return new ResponseEntity<>("Bad request", HttpStatus.BAD_REQUEST);
        } else {
            return new ResponseEntity<>("Item not found", HttpStatus.NOT_FOUND);
        }
    }
}

Important Notes

Always choose the status code that best matches what happened to help clients understand your response.

You can also use @ResponseStatus annotation for simple cases without a body.

Summary

Use ResponseEntity to send custom HTTP status codes and messages.

Common status codes include 200, 201, 400, 401, and 404.

Returning correct status codes improves communication with clients.

Practice

1. In Spring Boot, which class is commonly used to return different HTTP status codes from a controller?

easy

A. ResponseEntity

B. HttpStatusCode

C. HttpResponse

D. StatusCode

Solution

1. Step 1: Understand the purpose of ResponseEntity

   ResponseEntity is a Spring class that allows you to control the HTTP status code, headers, and body of the response.

2. Step 2: Identify the correct class for status codes

   HttpStatusCode, HttpResponse, and StatusCode are not standard Spring Boot classes for returning responses with status codes.

3. Final Answer:

   ResponseEntity -> Option A

4. Quick Check:

   Use ResponseEntity to return status codes [OK]

Hint: Use ResponseEntity to set status codes easily [OK]

Common Mistakes:

• Confusing ResponseEntity with HttpStatusCode
• Trying to return status codes without ResponseEntity
• Using non-existent classes like HttpResponse

2. Which of the following is the correct way to return a 404 Not Found status with a message in a Spring Boot controller?

easy

A. return new ResponseEntity("Not Found", 404);

B. return new ResponseEntity<>("Not Found", 404);

C. return ResponseEntity.status(404).body("Not Found");

D. return ResponseEntity(HttpStatus.NOT_FOUND, "Not Found");

Solution

1. Step 1: Check the syntax for ResponseEntity with status and body

   The method ResponseEntity.status(404).body("Not Found") correctly sets the status and body.

2. Step 2: Identify incorrect syntax options

   B uses a constructor with an int 404 instead of HttpStatus.NOT_FOUND. C uses an int instead of HttpStatus enum. D is not a valid constructor call.

3. Final Answer:

   return ResponseEntity.status(404).body("Not Found"); -> Option C

4. Quick Check:

   Use ResponseEntity.status().body() for custom status [OK]

Hint: Use ResponseEntity.status(code).body(message) [OK]

Common Mistakes:

• Using int instead of HttpStatus enum
• Incorrect constructor usage
• Missing method chaining for status and body

3. What will be the HTTP status code returned by this Spring Boot controller method?

public ResponseEntity<String> getUser(boolean found) {
    if (found) {
        return ResponseEntity.ok("User found");
    } else {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body("User not found");
    }
}

medium

A. 404 if found is true, 200 if false

B. Always 404

C. Always 200

D. 200 if found is true, 404 if false

Solution

1. Step 1: Analyze the if condition

   If found is true, the method returns ResponseEntity.ok("User found"), which means HTTP 200.

2. Step 2: Analyze the else condition

   If found is false, it returns ResponseEntity.status(HttpStatus.NOT_FOUND).body("User not found"), which means HTTP 404.

3. Final Answer:

   200 if found is true, 404 if false -> Option D

4. Quick Check:

   ResponseEntity.ok = 200, status(HttpStatus.NOT_FOUND) = 404 [OK]

Hint: ResponseEntity.ok = 200, status(HttpStatus.NOT_FOUND) = 404 [OK]

Common Mistakes:

• Mixing up true/false branches
• Assuming default status 200 always
• Confusing status codes with messages

4. Identify the error in this Spring Boot controller method that tries to return a 201 Created status:

public ResponseEntity<String> createItem() {
    return new ResponseEntity<>("Item created", 201);
}

medium

A. Cannot return ResponseEntity with a String body

B. Using int 201 instead of HttpStatus enum

C. ResponseEntity constructor requires three arguments

D. Missing @ResponseBody annotation

Solution

1. Step 1: Check ResponseEntity constructor parameters

   The constructor expects a body and an HttpStatus enum, not an int.

2. Step 2: Identify the incorrect use of status code

   Passing 201 as int causes a compilation error; should use HttpStatus.CREATED instead.

3. Final Answer:

   Using int 201 instead of HttpStatus enum -> Option B

4. Quick Check:

   Use HttpStatus.CREATED, not int 201 [OK]

Hint: Use HttpStatus enum, not int, for status codes [OK]

Common Mistakes:

• Passing int instead of HttpStatus enum
• Forgetting to import HttpStatus
• Assuming String body is invalid

5. You want to create a Spring Boot controller method that returns 201 Created when a new user is successfully added, 400 Bad Request if the input is invalid, and 401 Unauthorized if the user is not logged in. Which code snippet correctly implements this behavior?

hard

A. public ResponseEntity<String> addUser(boolean validInput, boolean loggedIn) {
if (!loggedIn) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("Unauthorized");
}
if (!validInput) {
return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("Invalid input");
}
return ResponseEntity.status(HttpStatus.CREATED).body("User created");
}

B. public ResponseEntity<String> addUser(boolean validInput, boolean loggedIn) {
if (!validInput) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("Unauthorized");
}
if (!loggedIn) {
return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("Invalid input");
}
return ResponseEntity.status(HttpStatus.CREATED).body("User created");
}

C. public ResponseEntity<String> addUser(boolean validInput, boolean loggedIn) {
if (!loggedIn) {
return new ResponseEntity<>("Unauthorized", 401);
}
if (!validInput) {
return new ResponseEntity<>("Invalid input", 400);
}
return new ResponseEntity<>("User created", 201);
}

D. }
;)102 ,"detaerc resU"(>gnirtS

Solution

1. Step 1: Verify correct use of HttpStatus enums

   public ResponseEntity<String> addUser(boolean validInput, boolean loggedIn) { if (!loggedIn) { return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("Unauthorized"); } if (!validInput) { return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("Invalid input"); } return ResponseEntity.status(HttpStatus.CREATED).body("User created"); } uses HttpStatus.UNAUTHORIZED, HttpStatus.BAD_REQUEST, and HttpStatus.CREATED enums correctly.

2. Step 2: Check logical order and syntax

   This code checks !loggedIn first, then !validInput, then returns 201. Options B, C, and D misuse status codes or pass ints to constructors instead of using HttpStatus enums.

3. Final Answer:

   Uses HttpStatus enums with correct logic: !loggedIn (401), !validInput (400), then 201 -> Option A

4. Quick Check:

   Use HttpStatus enums and correct logic order [OK]

Hint: Check login first, then input, use HttpStatus enums [OK]

Common Mistakes:

• Passing int status codes instead of HttpStatus enums
• Mixing up 400 and 401 status codes
• Incorrect order of condition checks