[Java][Feign] Expose response headers for feign client#10507
Merged
wing328 merged 11 commits intoOpenAPITools:masterfrom Oct 9, 2021
Merged
Conversation
This new property indicates if the feign client should expose the response headers on the API class.
Member
|
@hugo-ma-alves thanks for the PR. Have you considered the "usual" approach by adding an additional with the "WithHttpInfo" suffix to obtain HTTP headers, status code, etc ? For usual, I mean other clients (e.g. C#, Ruby, etc) have adopted such approach. |
…tor. Creates a new feign operation with the suffix WithHttpInfo, this operation returns the response encapsulated in a HttpResponse class. The HttpResponse class contains the decoded body and the response headers
…tor. Generate samples
…tor. Generate docs
Contributor
Author
|
@wing328 Thanks for the tip, I haven't checked the c# generator. I refactored the code to use the same approach as the C# generator. After pushing the changes I get this error on Circle CI: Can you force a new build? |
Member
|
Restarted. Let's see how it goes. |
Member
|
LGTM but I've not tested it locally |
Contributor
Author
|
Thanks |
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Hello
The objective of this PR is to add the possibility of exposing the response Headers of the request on the feign clients.
This is useful for some situations where the client needs to access information that it is contained on the response headers, for example, headers related with pagination, or resource location after creating a new resource.
I've created a new property called "exposeResponseHeaders", that by default is false, so if it is not defined we keep the same behavior as we have now.
If this property is active the response is wrapped in a new class HttpResponse. This class contains the headers map and the body decoded by jackson to the correct type.
Example of a generated client:
PR checklist
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.For Windows users, please run the script in Git BASH.
master(5.3.0),6.0.x@wing328
@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @nmuesch (2021/01)