Problem Details for standard error format in Spring Boot - Mini Project: Build & Apply

Problem Details for Standard Error Format in Spring Boot

📖 Scenario: You are building a Spring Boot REST API for a bookstore. When a client requests a book that does not exist, you want to return a clear and standard error response using the Problem Details format (RFC 7807).

🎯 Goal: Create a Spring Boot controller that returns a ProblemDetail response with a standard error format when a book is not found.

📋 What You'll Learn

Create a simple data structure to hold book information

Add a configuration variable for the error message

Implement a controller method that returns a ProblemDetail error when the book is missing

Complete the controller with proper annotations and response type

💡 Why This Matters

🌍 Real World

APIs often need to return clear, standardized error messages so clients can understand what went wrong. Using Problem Details format helps with this clarity.

💼 Career

Knowing how to implement standard error responses in Spring Boot is a valuable skill for backend developers building REST APIs.

1

DATA SETUP: Create a Map of books

Create a Map<String, String> called books with these exact entries: "123" mapped to "Spring Boot Guide" and "456" mapped to "Java Basics".

Spring Boot

// Create a Map called books with two entries
// Your code here

Hint

Use Map.of() to create an immutable map with the given entries.

2

CONFIGURATION: Add an error message variable

Create a String variable called errorMessage and set it to "Book not found".

Spring Boot

Map books = Map.of(
    "123", "Spring Boot Guide",
    "456", "Java Basics"
);

// Create a String variable errorMessage with value "Book not found"
// Your code here

Hint

Just assign the exact string to the variable errorMessage.

3

CORE LOGIC: Create a method to get a book or return ProblemDetail error

Create a method getBookById that takes a String id parameter. Use books.get(id) to find the book. If the book is null, return a ProblemDetail with status 404, title set to errorMessage, and detail set to "Book with id " + id + " not found". Otherwise, return the book title.

Spring Boot

Map books = Map.of(
    "123", "Spring Boot Guide",
    "456", "Java Basics"
);

String errorMessage = "Book not found";

// Create a method getBookById(String id) that returns Object
// Return ProblemDetail with status 404 if book not found
// Your code here

Hint

Use ProblemDetail.forStatus(HttpStatus.NOT_FOUND) to create the error response.

4

COMPLETION: Add Spring Boot annotations to the controller method

Annotate the class with @RestController. Annotate the getBookById method with @GetMapping("/books/{id}") and add a @PathVariable String id parameter. Ensure the method returns Object.

Spring Boot

@RestController
public class BookController {

    Map books = Map.of(
        "123", "Spring Boot Guide",
        "456", "Java Basics"
    );

    String errorMessage = "Book not found";

    @GetMapping("/books/{id}")
    public Object getBookById(@PathVariable String id) {
        String book = books.get(id);
        if (book == null) {
            ProblemDetail problem = ProblemDetail.forStatus(HttpStatus.NOT_FOUND);
            problem.setTitle(errorMessage);
            problem.setDetail("Book with id " + id + " not found");
            return problem;
        }
        return book;
    }

    // Your code here
}

Hint

Use @RestController on the class and @GetMapping with @PathVariable on the method.

Practice

1. What is the main purpose of using Problem Details in Spring Boot APIs?

easy

A. To standardize error messages for better clarity and consistency

B. To speed up API response times

C. To encrypt API responses for security

D. To generate API documentation automatically

Solution

1. Step 1: Understand the role of Problem Details

   Problem Details format is designed to provide a consistent structure for error messages in APIs.

2. Step 2: Identify the main benefit

   This standardization helps clients understand errors clearly and handle them properly.

3. Final Answer:

   To standardize error messages for better clarity and consistency -> Option A

4. Quick Check:

   Standard error format = clarity [OK]

Hint: Problem Details = clear, consistent error messages [OK]

Common Mistakes:

• Thinking it improves speed
• Confusing with security features
• Assuming it auto-generates docs

2. Which of the following fields is NOT part of the standard Problem Details JSON format?

easy

A. type

B. title

C. timestamp

D. status

Solution

1. Step 1: Recall standard Problem Details fields

   The standard fields include type, title, status, detail, and instance.

2. Step 2: Identify the incorrect field

   Timestamp is not part of the official Problem Details specification.

3. Final Answer:

   timestamp -> Option C

4. Quick Check:

   Standard fields exclude timestamp [OK]

Hint: Remember standard fields: type, title, status, detail, instance [OK]

Common Mistakes:

• Confusing timestamp with instance
• Assuming all error info fields are standard
• Mixing with custom fields

3. Given this Spring Boot controller snippet, what will be the HTTP status code in the Problem Details response when ResourceNotFoundException is thrown?

@RestController
public class MyController {
  @GetMapping("/item/{id}")
  public Item getItem(@PathVariable String id) {
    throw new ResourceNotFoundException("Item not found");
  }
}

medium

A. 404 Not Found

B. 200 OK

C. 500 Internal Server Error

D. 400 Bad Request

Solution

1. Step 1: Understand exception mapping in Spring Boot

   ResourceNotFoundException typically maps to HTTP 404 status to indicate missing resource.

2. Step 2: Confirm standard error status for not found

   Spring Boot's default error handling returns 404 for resource not found exceptions.

3. Final Answer:

   404 Not Found -> Option A

4. Quick Check:

   Resource missing = 404 [OK]

Hint: Resource not found usually means 404 status [OK]

Common Mistakes:

• Assuming 200 OK on exception
• Confusing 400 with 404
• Thinking all exceptions return 500

4. You wrote a custom exception handler to return Problem Details but the API returns a plain error message instead. What is the most likely cause?

medium

A. The exception class does not extend RuntimeException

B. The controller method is not annotated with @GetMapping

C. The application.properties file is missing

D. The handler method is missing @ExceptionHandler annotation

Solution

1. Step 1: Check exception handler setup

   Custom handlers must use @ExceptionHandler to catch exceptions and format responses.

2. Step 2: Identify missing annotation impact

   Without @ExceptionHandler, Spring Boot won't invoke the handler, so default error response is sent.

3. Final Answer:

   The handler method is missing @ExceptionHandler annotation -> Option D

4. Quick Check:

   @ExceptionHandler missing = no custom error [OK]

Hint: Always add @ExceptionHandler to custom error methods [OK]

Common Mistakes:

• Thinking controller mapping affects exception handling
• Assuming properties file controls error format
• Believing exception must extend RuntimeException

5. How can you customize the type field in a Problem Details response for a specific exception in Spring Boot?

hard

A. Override the toString() method of the exception class

B. Create a @ControllerAdvice with @ExceptionHandler and build a ProblemDetail with custom type URI

C. Set a property in application.properties named error.type.custom

D. Add a @RequestMapping with produces = "application/problem+json" on the controller

Solution

1. Step 1: Use @ControllerAdvice and @ExceptionHandler

   To customize error details, define a global handler that catches the exception.

2. Step 2: Build ProblemDetail with custom type URI

   Inside the handler, create a ProblemDetail object and set the type field to a custom URI describing the error.

3. Final Answer:

   Create a @ControllerAdvice with @ExceptionHandler and build a ProblemDetail with custom type URI -> Option B

4. Quick Check:

   Custom type = @ExceptionHandler + ProblemDetail [OK]

Hint: Use @ExceptionHandler to customize ProblemDetail fields [OK]

Common Mistakes:

• Trying to override toString() for error format
• Expecting properties file to set type field
• Using @RequestMapping alone to customize error