A simple class which makes using REST services like the GitHub API really easy. This utilizes helpful features of Groovy while not relying on any heavier external libraries for HTTP communication.
Type Params | Return Type | Name and description |
---|---|---|
|
static String |
addTrailingSlash(String url, String suffix = '') Meant for flexibly setting API URLs, this will enforce a trailing slash and optionaly a suffix such as an API version applied to the URL. |
|
static def |
apiFetch(URL api_url, Map http_headers = [:], String http_method = 'GET', String data = '') apiFetch() can be used to submit HTTP commands common to REST APIs. |
|
static String |
objToJson(def obj) A method for converting an object comprising of standard Java classes Map or List to a JSON String. |
Meant for flexibly setting API URLs, this will enforce a trailing slash and optionaly a suffix such as an API version applied to the URL.
url
- Typically an API URL where a trailing slash will be added if
missing.suffix
- Typically an API version path where a trailing slash will be
added if missing. If this option is provided, then it will
ensure url ends with the suffix and add it
if missing.apiFetch() can be used to submit HTTP commands common to REST APIs. If http_headers does not contain a Content-Type header, then application/json is assumed.
Extra behaviors are provided by special http_headers. These headers are not sent over HTTP but instead change the behavior of the response.
api_url
- A URL of a REST endpoint in which to make an HTTP call.http_headers
- HTTP headers to pass as part of the HTTP request. By
default only Content-Type: application/json
HTTP header will be set.http_method
- The HTTP method or action to request from the server.
Currently supported methods include: GET, POST, PUT,
DELETE, and PATCH.A method for converting an object comprising of standard Java classes Map or List to a JSON String.
obj
- Any object.