Exception handling support for "problem details" rfc7807

[dirweis]

According to RFC-7807 (see https://tools.ietf.org/html/rfc7807) it would be useful to provide an invalid-params field in case of 400 Bad Request errors. This field is supposed to contain ALL violated parameters, no matter which Exception type is caught by the ExceptionHandler annotated methods.

Since in case of multiple violations it is possible that Exceptions of different types occur (e.g. ConstraintViolationException and MethodArgumentTypeMismatchException from one request), those Exception objects must be available in the ExceptionHandler.

A solution would be a resolver for a List of Exceptions.

[bclozel]

We could use this issue as the basis for a broader rfc7808 "Problem Details for HTTP APIs". Spring Boot has an issue about this (see spring-projects/spring-boot#19525), but we're likely to need infrastructure support from Spring Web Frameworks.

[dirweis]

Great, thank you, @bclozel !
Maybe you can use my second Issue in Exception Handlers as well as the basis for a broader rfc7808 "Problem Details for HTTP APIs":
https://github.com/spring-projects/spring-boot/issues/25105

[npathai]

I can work on this if it's available. I am a first time contributor, do let me know if this is something a first timer can take a dig on.

[bclozel]

Hello @npathai

I've tagged this issue with "status: pending-design-work".

In this case, we know that Spring HATEOAS and 3rd party Spring Boot starters provide features in this space. We don't know how this would be support in Spring Framework yet. From turning business exceptions into problem details instances, providing an error handling infrastructure, helping to localize error messages and URLs to error pages, etc. Some of this could be in Spring Framework, other parts should belong in Spring Boot.

We know that this feature requires significant changes and we'd like to tackle it in the Spring Framework 6.x timeline.

We're happy to have community members like you willing to help. In general, you should try and look for "status: ideal-for-contribution" issues. Arguably, they're not really common in Spring Framework because many issues are really specific, but other Spring projects have more of those. Many community members start by contributing documentation improvements, fixing typos, or answering questions on StackOverflow.

Thanks!

[npathai]

@bclozel Sure, sounds reasonable. Thanks for the insight. I contribute in other projects but was starting to look into open issues in Spring. I will look into other Spring projects 👍

[rstoyanchev]

@dirweis there is only a single exception that is raised and resolved through the HandlerExceptionResolver contract. So it would be ConstraintViolationException or MethodArgumentTypeMismatchException, never both. Can you clarify what you have in mind?