Problem Details for standard error format in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the Problem Details standard format in Spring Boot?

It provides a consistent way to return error information in HTTP responses, making it easier for clients to understand and handle errors.

beginner

Which HTTP status code is commonly used with Problem Details responses?

Status codes like 400 (Bad Request), 404 (Not Found), and 500 (Internal Server Error) are commonly used with Problem Details to indicate the error type.

intermediate

Name the key JSON fields defined in the Problem Details format.

The key fields are: type (URI identifying the error type), title (short summary), status (HTTP status code), detail (detailed message), and instance (URI identifying the specific occurrence).

intermediate

How can you customize the Problem Details response in Spring Boot?

You can create a custom ProblemDetail object or extend the default error handling by implementing ErrorAttributes or using @ExceptionHandler methods to set custom fields.

beginner

Why is using Problem Details format better than plain error messages?

It standardizes error responses, making them machine-readable and easier to parse, which improves client-side error handling and debugging.

What field in Problem Details contains a short, human-readable summary of the error?

A instance

B type

C status

D title

The title field provides a brief, human-readable summary of the problem.

Which Spring Boot class represents the Problem Details error format?

A ErrorAttributes

B ErrorResponse

C ProblemDetail

D ResponseEntity

Spring Boot uses the ProblemDetail class to represent the standard error format.

What HTTP status code is NOT typically associated with Problem Details errors?

A 404

B 200

C 400

D 500

Status code 200 means success and is not used for error responses.

Which field in Problem Details identifies the specific occurrence of the problem?

A instance

B type

C detail

D status

The instance field is a URI that identifies the specific occurrence of the problem.

How can you add custom information to a Problem Details response in Spring Boot?

A By extending the ProblemDetail object or customizing ErrorAttributes

B By changing the HTTP status code only

C By modifying the request headers

D By using plain text responses

Customizing the ProblemDetail object or ErrorAttributes allows adding extra fields or details.

Explain the main fields of the Problem Details format and their purpose.

Think about what each field tells the client about the error.

Describe how Spring Boot supports and customizes the Problem Details error format.

Consider how you can change the error response content.

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