Problem Details for standard error format in Spring Boot - Step-by-Step Execution

Concept Flow - Problem Details for standard error format

Client sends request

↓

Server processes request

↓

Error occurs?

No→Send normal response

Yes↓

Create Problem Details object

↓

Fill fields: type, title, status, detail, instance

↓

Send Problem Details JSON as error response

↓

Client receives standardized error info

This flow shows how a Spring Boot server handles errors by sending a standardized Problem Details JSON response to the client.

Execution Sample

Spring Boot

import org.springframework.http.HttpStatus;
import org.springframework.http.ProblemDetail;
import org.springframework.http.ResponseEntity;

ProblemDetail pd = ProblemDetail.forStatus(HttpStatus.NOT_FOUND);
pd.setDetail("User with ID 123 not found.");
return ResponseEntity.status(pd.getStatus()).body(pd);

This code creates a Problem Details object for a 404 error with a custom detail message and returns it as the HTTP response body.

Execution Table

Step	Action	ProblemDetail Fields Set	HTTP Status	Response Sent
1	Receive client request	{}	N/A	No response yet
2	Process request	{}	N/A	No response yet
3	Detect resource missing	{}	N/A	No response yet
4	Create ProblemDetail object	{"type": "about:blank", "title": "Not Found", "status": 404}	404	No response yet
5	Set detail message	{"type": "about:blank", "title": "Not Found", "status": 404, "detail": "User with ID 123 not found."}	404	No response yet
6	Send response with ProblemDetail JSON	{"type": "about:blank", "title": "Not Found", "status": 404, "detail": "User with ID 123 not found."}	404	Problem Details JSON sent

💡 Response sent with Problem Details JSON and HTTP status 404

Variable Tracker

Variable	Start	After Step 4	After Step 5	Final
pd	null	{"type": "about:blank", "title": "Not Found", "status": 404}	{"type": "about:blank", "title": "Not Found", "status": 404, "detail": "User with ID 123 not found."}	{"type": "about:blank", "title": "Not Found", "status": 404, "detail": "User with ID 123 not found."}

Key Moments - 2 Insights

Why do we use ProblemDetail.forStatus(HttpStatus.NOT_FOUND) instead of creating ProblemDetail manually?

Using forStatus() sets standard fields like type, title, and status automatically, ensuring consistency as shown in execution_table step 4.

What happens if we don't set the detail field?

The ProblemDetail will still be valid but less informative; detail is optional but recommended for clarity, as seen in step 5 where detail is added.

Visual Quiz - 3 Questions

Look at the execution_table at step 5, what field is added to the ProblemDetail object?

A detail

B status

C type

D title

💡 Hint

Check the 'ProblemDetail Fields Set' column at step 5 in the execution_table.

At which step is the HTTP status code set in the ProblemDetail object?

A Step 3

B Step 5

C Step 4

D Step 6

💡 Hint

Look at the 'HTTP Status' column in the execution_table to see when status becomes 404.

If the server did not detect an error, what would happen according to the concept_flow?

A Send Problem Details JSON anyway

B Send normal response

C Create ProblemDetail object but do not send

D Return empty response

💡 Hint

Refer to the decision branch 'Error occurs?--No--> Send normal response' in the concept_flow.

Concept Snapshot

Problem Details standardizes error responses in JSON.
Use ProblemDetail.forStatus() to create error info.
Set fields: type, title, status, detail, instance.
Return ProblemDetail as HTTP response body.
Clients get consistent, clear error messages.

Full Transcript

When a client sends a request to a Spring Boot server, the server processes it. If an error occurs, such as a missing resource, the server creates a ProblemDetail object using ProblemDetail.forStatus() which sets standard fields like type, title, and status. Then, it adds a detail message explaining the error. Finally, the server sends this ProblemDetail JSON as the error response with the appropriate HTTP status code. This standard format helps clients understand errors clearly and consistently.