- The plugin adds a new task named
rest. This task exposes the following properties -
-
httpMethod - The type of HTTP method to execute. Type: String. Default:
get. Possible values:delete,get,head,options,post,put. -
uri - The target URI of the request. An invocation of toString() on the value should result in a valid URI. Type: Object.
-
username - Authentication username. Type: String.
-
password - Authentication password. Type: String.
-
contentType - The expected content type of both request and response. Type: groovyx.net.http.ContentType / String.
-
requestContentType - The expected content type of the request. Overrides the
contentTypeparameter. Type: groovyx.net.http.ContentType / String. -
requestBody - The request content. Type: Object.
-
requestHeaders - Additional request headers. Type: Map.
-
responseHandler - A custom successful request handler. Type: groovy.lang.Closure. The closure accepts one parameter. May accept the types String, InputStream or Object which falls back to the client’s default handler.
-
For example, a POST request task:
task attack(type: org._10ne.gradle.rest.RestTask) {
httpMethod = 'post'
uri = 'https://battle.server.com/attack'
username = 'player'
password = 'password'
requestBody = [battleCry: 'FOR LEEROY JENKINS!']
contentType = groovyx.net.http.ContentType.JSON
requestHeaders = [customHeader: 'WoW']
responseHandler = {
//Configured content type is JSON and we let the client's handler parse the response for us
assert it.message == 'success'
}
}