Skip to content

Commit 7ffd2f6

Browse files
authored
Clarify the general purpose of the belgif-rest-problem library (#26)
1 parent 484a321 commit 7ffd2f6

File tree

2 files changed

+24
-11
lines changed

2 files changed

+24
-11
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,15 @@
44
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=belgif_rest-problem-java&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=belgif_rest-problem-java)
55
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=belgif_rest-problem-java&metric=coverage)](https://sonarcloud.io/summary/new_code?id=belgif_rest-problem-java)
66

7-
Java library for RFC 9457 Problems with support for standard problem types of the Belgif REST guide (https://www.belgif.be/specification/rest/api-guide/#error-handling).
7+
Java library for [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problems with support for standard problem types of
8+
the [Belgif REST guide](https://www.belgif.be/specification/rest/api-guide/#error-handling).
9+
10+
With this library, RFC 9457 Problems can be treated as standard java exceptions:
11+
12+
* the server side can throw `io.github.belgif.rest.problem.api.Problem` exceptions (or subclasses), which are
13+
transparently converted to RFC 9457 compliant "application/problem+json" responses
14+
* the client side can catch `io.github.belgif.rest.problem.api.Problem` exceptions (or subclasses), which are
15+
transparently thrown when an RFC 9457 compliant "application/problem+json" response is received
816

917
## build process
1018

src/main/asciidoc/index.adoc

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,21 @@
1111

1212
= belgif-rest-problem
1313

14+
== Context
15+
16+
Java library for working with https://www.belgif.be/specification/rest/api-guide/#error-handling[RFC 9457 standardized Belgif problems].
17+
18+
With this library, RFC 9457 Problems can be treated as standard java exceptions:
19+
20+
* the server side can throw `io.github.belgif.rest.problem.api.Problem` exceptions (or subclasses), which are transparently converted to RFC 9457 compliant "application/problem+json" responses
21+
* the client side can catch `io.github.belgif.rest.problem.api.Problem` exceptions (or subclasses), which are transparently thrown when an RFC 9457 compliant "application/problem+json" response is received
22+
23+
The library consists of these modules:
24+
25+
* <<belgif-rest-problem>>: library for RFC 9457 standardized Belgif problems
26+
* <<belgif-rest-problem-java-ee>>: Java EE / Jakarta EE integration for belgif-rest-problem
27+
* <<belgif-rest-problem-spring>>: Spring Boot integration for belgif-rest-problem
28+
1429
== Release notes
1530

1631
=== Version 0.2
@@ -33,16 +48,6 @@
3348

3449
Initial release under Belgif organization.
3550

36-
== Context
37-
38-
Java library for working with https://www.belgif.be/specification/rest/api-guide/#error-handling[RFC 9457 standardized Belgif problems].
39-
40-
The library consists of these modules:
41-
42-
* <<belgif-rest-problem>>: library for RFC 9457 standardized Belgif problems
43-
* <<belgif-rest-problem-java-ee>>: Java EE / Jakarta EE integration for belgif-rest-problem
44-
* <<belgif-rest-problem-spring>>: Spring Boot integration for belgif-rest-problem
45-
4651
[[belgif-rest-problem]]
4752
== belgif-rest-problem
4853

0 commit comments

Comments
 (0)