Skip to content

Commit bd4db25

Browse files
committed
Update README.md
1 parent dd43d03 commit bd4db25

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,13 @@
44
[![Sonatype](https://img.shields.io/maven-central/v/io.github.malczuuu.problem4j/problem4j-spring-bom)](https://central.sonatype.com/artifact/io.github.malczuuu.problem4j/problem4j-spring-bom)
55
[![License](https://img.shields.io/github/license/malczuuu/problem4j-spring)](https://github.com/malczuuu/problem4j-spring/blob/main/LICENSE)
66

7-
Spring integration module for [`problem4j-core`][problem4j-core]. library that integrates the RFC Problem Details model
8-
with exception handling in Spring Boot.
7+
Designing clear and consistent error responses in a REST API is often harder than it looks. Without a shared standard,
8+
each application ends up inventing its own ad-hoc format, which quickly leads to inconsistency and confusion. [RFC 7807 —
9+
Problem Details for HTTP APIs][rfc7807] solves this by defining a simple, extensible JSON structure for error messages.
10+
11+
**Problem4J** brings this specification into the Spring ecosystem, offering a practical way to model, throw, and handle
12+
API errors using `Problem` objects. It helps you enforce a consistent error contract across your services, while staying
13+
flexible enough for custom exceptions and business-specific details.
914

1015
## Table of Contents
1116

@@ -16,6 +21,9 @@ with exception handling in Spring Boot.
1621

1722
## Features
1823

24+
This module provides Spring integration for [`problem4j-core`][problem4j-core]. library that integrates the RFC Problem
25+
Details model with exception handling in Spring Boot.
26+
1927
- ✅ Automatic mapping of exceptions to responses with `Problem` objects compliant with [RFC 7807][rfc7807].
2028
- ✅ Mapping of exceptions extending `ProblemException` to responses with `Problem` objects.
2129
- ✅ Mapping of exceptions annotated with `@ProblemMapping` to responses with `Problem` objects.

0 commit comments

Comments
 (0)