feign

Annotation Type Headers

@Target(value={METHOD,TYPE})
 @Retention(value=RUNTIME)
public @interface Headers

Expands headers supplied in the value. Variables to the the right of the colon are expanded.

 @Headers("Content-Type: application/xml")
 interface SoapApi {
 ...   
 @RequestLine("GET /")
 @Headers("Cache-Control: max-age=640000")
 ...

 @RequestLine("POST /")
 @Headers({
   "X-Foo: Bar",
   "X-Ping: {token}"
 }) void post(@Param("token") String token);
 ...
 

Notes:

• If you'd like curly braces literally in the header, urlencode them first.
• Headers do not overwrite each other. All headers with the same name will be included in the request.

Relationship to JAXRS

The following two forms are identical.

Feign:

 @RequestLine("POST /")
 @Headers({
   "X-Ping: {token}"
 }) void post(@Named("token") String token);
 ...
 

JAX-RS:

 @POST @Path("/")
 void post(@HeaderParam("X-Ping") String token);
 ...
 

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	value

Element Detail

value

public abstract String[] value