Returning Status Codes with ResponseEntity

Introduction

Welcome to this lesson! Previously, you've focused on handling the standard scenarios when building REST APIs with Spring Boot. Now, you'll delve into how to manage situations where users make invalid requests, such as trying to access resources that do not exist. To achieve this, you'll utilize ResponseEntity in Spring Boot. This allows you to return meaningful HTTP status codes, which indicate the success or failure of the operations, making your APIs more reliable and user-friendly.

HTTP Status Codes Overview

To begin, familiarize yourself with HTTP status codes. When a server responds to a request, it includes a status code that indicates the outcome. A status code is a 3-digit number, such as 200 or 404. HTTP status codes are categorized into five groups: 1xx (Informational): Request received, continuing process. 2xx (Successful): The request was successfully received, understood, and accepted. 3xx (Redirection): Further action needs to be taken to complete the request. 4xx (Client Error): The request contains bad syntax or cannot be fulfilled. 5xx (Server Error): The server failed to fulfill an apparently valid request.

Common HTTP Status Codes

Next, focus on the most commonly used status codes that you’ll be dealing with in this lesson: Status Code Description 200 OK - The request has succeeded 201 Created - The request has been fulfilled, resulting in the creation of a new resource 204 No Content - The server successfully processed the request, but is not returning any content 400 Bad Request - The server could not understand the request due to invalid syntax 401 Unauthorized - The client must authenticate itself to get the requested response 404 Not Found - The server can not find the requested resource 500 Internal Server Error - The server has encountered a situation it doesn't know how to handle

Status Code	Description
200	OK - The request has succeeded
201	Created - The request has been fulfilled, resulting in the creation of a new resource
204	No Content - The server successfully processed the request, but is not returning any content
400	Bad Request - The server could not understand the request due to invalid syntax
401	Unauthorized - The client must authenticate itself to get the requested response
404	Not Found - The server can not find the requested resource
500	Internal Server Error - The server has encountered a situation it doesn't know how to handle

Understanding ResponseEntity

In Spring Boot, returning appropriate HTTP status codes is crucial for building robust APIs. The ResponseEntity class helps streamline this process. It provides a way to return not only the status code but also the HTTP headers and the body of the response. This makes the responses more informative and standardized.

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Java

@GetMapping("/recipes/{id}")
public ResponseEntity<RecipeItem> getRecipeById(@PathVariable UUID id) {
    RecipeItem recipe = recipeRepository.findById(id);
    if (recipe == null) {
        return new ResponseEntity<>(HttpStatus.NOT_FOUND); // Returns 404 Not Found if the item doesn't exist
    }
    return new ResponseEntity<>(recipe, HttpStatus.OK); // Returns 200 OK if the item exists
}

@GetMapping("/recipes/{id}")
public ResponseEntity<RecipeItem> getRecipeById(@PathVariable UUID id) {
    RecipeItem recipe = recipeRepository.findById(id);
    if (recipe == null) {
        return new ResponseEntity<>(HttpStatus.NOT_FOUND); // Returns 404 Not Found if the item doesn't exist
    }
    return new ResponseEntity<>(recipe, HttpStatus.OK); // Returns 200 OK if the item exists
}

Java

@GetMapping("/recipes/{id}")
public ResponseEntity<RecipeItem> getRecipeById(@PathVariable UUID id) {
    RecipeItem recipe = recipeRepository.findById(id);
    if (recipe == null) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).build(); // Returns 404 Not Found if the item doesn't exist
    }
    return ResponseEntity.ok(recipe); // Returns 200 OK if the item exists
}

@GetMapping("/recipes/{id}")
public ResponseEntity<RecipeItem> getRecipeById(@PathVariable UUID id) {
    RecipeItem recipe = recipeRepository.findById(id);
    if (recipe == null) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).build(); // Returns 404 Not Found if the item doesn't exist
    }
    return ResponseEntity.ok(recipe); // Returns 200 OK if the item exists
}

Java

@GetMapping("/recipes/{id}")
public ResponseEntity<RecipeItem> getRecipeById(@PathVariable UUID id) {
    RecipeItem recipe = recipeRepository.findById(id);
    if (recipe == null) {
        return new ResponseEntity<>(HttpStatus.NOT_FOUND); // Returns 404 Not Found if the item doesn't exist
    }
    return new ResponseEntity<>(recipe, HttpStatus.OK); // Returns 200 OK if the item exists
}

Java

@GetMapping("/recipes/{id}")
public ResponseEntity<RecipeItem> getRecipeById(@PathVariable UUID id) {
    RecipeItem recipe = recipeRepository.findById(id);
    if (recipe == null) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).build(); // Returns 404 Not Found if the item doesn't exist
    }
    return ResponseEntity.ok(recipe); // Returns 200 OK if the item exists
}

Introduction

HTTP Status Codes Overview

Common HTTP Status Codes

Understanding ResponseEntity

Join the 1M+ learners on CodeSignal

ResponseEntity in Action

ResponseEntity Methods

Using the ResponseEntity Builder Pattern

Other ResponseEntity Methods

Summary