feign.RequestLine Maven / Gradle / Ivy

Go to download
package feign;

import java.lang.annotation.Retention;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Expands the request-line supplied in the {@code 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);
 * ...
 * 
 */
@java.lang.annotation.Target(METHOD)
@Retention(RUNTIME)
public @interface RequestLine {

  String value();
  boolean decodeSlash() default true;
}