retrofit2.http

Annotation Type HTTP

@Documented
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface HTTP

Use a custom HTTP verb for a request.

 interface Service {
   @HTTP(method = "CUSTOM", path = "custom/endpoint/")
   Call<ResponseBody> customEndpoint();
 }
 

This annotation can also used for sending DELETE with a request body:

 interface Service {
   @HTTP(method = "DELETE", path = "remove/", hasBody = true)
   Call<ResponseBody> deleteObject(@Body RequestBody object);
 }
 

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	method

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	hasBody
String	path A relative or absolute path, or full URL of the endpoint.

Element Detail

method

public abstract String method

path

public abstract String path

A relative or absolute path, or full URL of the endpoint. This value is optional if the first parameter of the method is annotated with @Url.

See base URL for details of how this is resolved against a base URL to create the full endpoint URL.

Default:

""

hasBody

public abstract boolean hasBody

Default:

false