feat(decorator): @ApiResponse annotation, support multiple response body examples #1455
+64
−3
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.
PR Checklist
Please check if your PR fulfills the following requirements:
I couldn't find the CHANGELOG.md file
If you guide me, I will edit the document.
PR Type
What kind of change does this PR introduce?
What is the current behavior?
I would like to document and expose multiple response situations for the same http response status code.
It is supported in openapi 3.0.0, and the 'examples' key in the response content has been modified to be usable.
Issue Number: N/A
What is the new behavior?
Support for optional examples key for @ApiResponse annotation
- support to show multiple response body examples in one response code.
Does this PR introduce a breaking change?
Other information
I added one simple test case.