Support for @JsonView on @ExceptionHandler methods #1159
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, springdoc-api ignores the
@JsonView
annotation on exception handler methods, and it generates a generic schema(all fields) for the ResponseBean. However, spring rest supports@JsonView
annotation on exception handler methods and generates a different schema for different Views of ResponseBean.This PR introduces the support for
@JsonView
annotation on Exception handler methods.In the below example, exception handlers for INTERNAL_SERVER_ERROR and BAD_REQUEST have different JsonViews, but springdoc generates the same schema /components/schemas/FooBean for both error responses.
//Existing response. Documentation is not generated as per
@JsonView
annotation//After this PR
In the below example, springdoc generates the different schema (#/components/schemas/FooBean_View1 , #/components/schemas/FooBean_View2) for error responses.