feign

Annotation Type RequestLine

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface RequestLine

Expands the request-line supplied in the value, permitting path and query variables, or just the http method.

 ...
 @RequestLine("POST /servers")
 ...

 @RequestLine("GET /servers/{serverId}?count={count}")
 void get(@Param("serverId") String serverId, @Param("count") int count);
 ...

 @RequestLine("GET")
 Response getNext(URI nextLink);
 ...
 

HTTP version suffix is optional, but permitted. There are no guarantees this version will impact that sent by the client.

 @RequestLine("POST /servers HTTP/1.1")
 ...
 

Note: Query params do not overwrite each other. All queries with the same name will be included in the request.

Relationship to JAXRS

The following two forms are identical.
Feign:

 @RequestLine("GET /servers/{serverId}?count={count}")
 void get(@Param("serverId") String serverId, @Param("count") int count);
 ...
 

JAX-RS:

 @GET @Path("/servers/{serverId}")
 void get(@PathParam("serverId") String serverId, @QueryParam("count") int count);
 ...
 

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
CollectionFormat	collectionFormat
boolean	decodeSlash

Element Detail

value

public abstract String value

decodeSlash

public abstract boolean decodeSlash

Default:

true

collectionFormat

public abstract CollectionFormat collectionFormat

Default:

feign.CollectionFormat.EXPLODED