Access an external REST API

Abstract

This code snippet accesses an external REST API through a Groovy script written in the Groovy editor of the add-on.

Logic

• Import the HTTPBuilder and the required request methods.
• Create a new HTTP instance.
• Pass the method, the content type, and the request configuration closure to the request method.
• Handle the responses and content.

Snippet 

import groovyx.net.http.HTTPBuilder
import static groovyx.net.http.Method.<methodName>
import static groovyx.net.http.ContentType.<contentType>
 
// initialize a new builder and give a default URL
def http = new HTTPBuilder("<URL>")
 
http.request(<methodName>,<contentType>) { req ->
 
  response.success = { resp, reader ->
    assert resp.status == 200
	return reader
  }
 
  // called only for a 404 (not found) status code:
  response."404" = { resp ->
    return "Not found"
  }
}

Placeholders

Context

The outcome of the code snippet depends on the content type passed to the request method. You could use this code, for example, to get a specific currency conversion rate.

Use cases

• /wiki/spaces/IN/pages/447381518

Reference

• HTTPBuilder
• Groovy Documentation

Related articles