https://github.com/belgif/rest-problem-java

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)
https://github.com/belgif/rest-problem-java

Last synced: about 21 hours ago
JSON representation

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)

• Host: GitHub
• URL: https://github.com/belgif/rest-problem-java
• Owner: belgif
• License: apache-2.0
• Created: 2024-04-12T11:38:04.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-11-05T09:21:42.000Z (11 days ago)
• Last Synced: 2024-11-05T10:18:43.088Z (11 days ago)
• Language: Java
• Homepage: https://belgif.github.io/rest-problem-java/
• Size: 1.58 MB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rest-problem-java

[![maven-ci-build](https://github.com/belgif/rest-problem-java/actions/workflows/maven-ci-build.yml/badge.svg)](https://github.com/belgif/rest-problem-java/actions/workflows/maven-ci-build.yml)

[![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)

[![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)

[![Maven Central Version](https://img.shields.io/maven-central/v/io.github.belgif.rest.problem/belgif-rest-problem?color=green)](https://central.sonatype.com/namespace/io.github.belgif.rest.problem)

Java library for [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problems with support for standard problem types of

the [Belgif REST guide](https://www.belgif.be/specification/rest/api-guide/#error-handling).

With this library, RFC 9457 Problems can be treated as standard java exceptions:

* 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

* 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

## Documentation

Documentation on how to use this library is available on https://belgif.github.io/rest-problem-java.

## Build Process

The build process is documented [here](https://github.com/belgif/rest-problem-java/blob/master/BUILDING.md).