Quarkus Rest Client: Passing a map of headers to the client interface methods

[VphDreamer]

Description

With Quarkus Rest Client, it is possible to pass headers to the "proxy" methods through ClientHeaderParam or HeaderParam, both of these options require having early knowledge of the headers names during development phase. It would be nice to be able to pass a map of headers similar to what is done for the query parameters via RestQuery. It provides more flexibility for cases where headers are known only during runtime and when it is easier to pass them as parameters instead of using factories or filters.

Implementation ideas

A new annotation @RestHeader similar to @RestQuery .

[quarkus-bot]

/cc @cescoffier (rest-client), @geoand (rest-client)

[geoand]

Just so I can verify that I understand what you are asking, can you paste a snippet of code of what you have in mind that you would like to be supported?

[VphDreamer]

Hello @geoand
I mean some thing like this:

@Path("/")
@RegisterRestClient
public interface CustomService {

    @GET
    String get(@RestHeader MultivaluedMap<String, String> headers); 
}

[geoand]

Thanks, that's what I thought. Are you sure that doesn't work already?

[VphDreamer]

Yes, I searched over the documentation, I didn't find something similar.

[geoand]

Let me try and see if we support it (I vaguely remember something similar)

[geoand]

Indeed it seems that it doesn't currently work.

[geoand]

#24764 did the same thing for query params