problem-details-java

Standard error responses for Java APIs — one model, JSON and XML output, Spring and Jakarta REST support.

If your API returns errors (it does), this library makes them consistent: every error carries the same five fields defined by RFC 9457, so clients only learn one format. New here? The Quickstart gets you there in five minutes.

Pick your path

• First time? Quickstart, then Core concepts.
• Sending JSON? JSON. Sending XML? XML.
• Using Spring? Spring. Using Jakarta REST? JAX-RS.
• Reusing error types? Registry.
• Running it? Demos — two working apps you can start in a minute.
• Looking something up? API reference, Compatibility, FAQ.

At a glance

Works on Java 17 and newer. The core has no dependencies at all; each extra piece (JSON, Spring, …) is a module you add only if you need it.

Licensed under the Apache License 2.0 — see LICENSE.