Returning different status codes in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

How do you return a 200 OK status with a response body in Spring Boot?

Use ResponseEntity.ok(body) to return a 200 OK status with the given response body.

beginner

What class in Spring Boot helps you customize HTTP status codes in responses?

The <code>ResponseEntity</code> class allows you to set the HTTP status code, headers, and body in your response.

beginner

How can you return a 404 Not Found status when a resource is missing?

Return ResponseEntity.notFound().build() to send a 404 Not Found status without a body.

intermediate

What annotation can you use to set the HTTP status code directly on a controller method?

Use <code>@ResponseStatus(HttpStatus.CODE)</code> on a method or exception class to set the HTTP status code.

intermediate

How do you return a 201 Created status with a location header in Spring Boot?

Use ResponseEntity.created(URI).body(body) to return 201 Created with a Location header pointing to the new resource.

Which Spring Boot class lets you set HTTP status codes in responses?

A HttpServletRequest

B RequestMapping

C RestController

D ResponseEntity

ResponseEntity is used to customize HTTP status codes, headers, and body in Spring Boot responses.

How do you return a 404 Not Found status without a body?

A return new ResponseEntity<>(HttpStatus.OK);

B return ResponseEntity.notFound().build();

C return ResponseEntity.ok().build();

D return ResponseEntity.badRequest().build();

ResponseEntity.notFound().build() returns a 404 status with no body.

Which annotation sets a fixed HTTP status code on a controller method?

A @ResponseStatus

B @RestController

C @GetMapping

D @RequestMapping

@ResponseStatus sets the HTTP status code for the method or exception.

What status code is typically returned when a new resource is created?

A 200 OK

B 404 Not Found

C 201 Created

D 500 Internal Server Error

201 Created indicates a new resource was successfully created.

How do you include a Location header pointing to a new resource in the response?

A ResponseEntity.created(URI).body(body)

B ResponseEntity.ok().header("Location", url).body(body)

C ResponseEntity.badRequest().build()

D ResponseEntity.notFound().build()

ResponseEntity.created(URI).body(body) sets the Location header and returns 201 Created.

Explain how to return different HTTP status codes from a Spring Boot controller method.

Think about ResponseEntity methods and the @ResponseStatus annotation.

Describe how to return a 201 Created status with a Location header in Spring Boot.

Focus on ResponseEntity.created and URI usage.

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