REST service classes can derive some default implementation from this trait.
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. |
|
def |
apiFetch(String path = '', Map http_headers = [:], String http_method = 'GET', String data = '') This is a convenient method for making API calls to remote REST services. |
|
def |
apiFetch(String path, Map http_headers, String http_method, Map data) This method is provided for REST client development convenience. |
|
String |
baseUrl() A method for getting the API URL which will be used by apiFetch(java.lang.String, java.util.Map, java.lang.String, java.lang.String). |
|
Map |
header(Map original_headers) A method for getting authentication headers and other default headers used by apiFetch(java.lang.String, java.util.Map, java.lang.String, java.lang.String). |
|
static String |
objToJson(Map obj) A method for converting a HashMap of standard Java types 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.This is a convenient method for making API calls to remote REST services. It automatically builds out authentication headers by calling other methods defined in this trait.
path
- A path appended to the baseUrl() for making
an API call.http_headers
- A list of user or client-provided headers. These
provided headers get passed to
header(java.util.Map).http_method
- The HTTP method to call when making an API request.
Non-standard HTTP verbs can also be provided for REST
services that support custom verbs.data
- Data to be written to the remote service upon API request.
This is typically done via HTTP POST method but other
methods can also accept data written.This method is provided for REST client development convenience. This calls apiFetch(java.lang.String, java.util.Map, java.lang.String, java.lang.String) for JSON-based APIs.
path
- A path appended to the baseUrl() for making
an API call.http_headers
- A list of user or client-provided headers. These
provided headers get passed to
header(java.util.Map).http_method
- The HTTP method to call when making an API request.
Non-standard HTTP verbs can also be provided for REST
services that support custom verbs.data
- Assuming a Map consisting of standard Java types, performs
objToJson(java.util.Map) on the
data parameter. Submits JSON data to the remote API.A method for getting the API URL which will be used by apiFetch(java.lang.String, java.util.Map, java.lang.String, java.lang.String). When developing an API client extending SimpleRestServiceSupport you can call addTrailingSlash(java.lang.String, java.lang.String) for convenience.
A method for getting authentication headers and other default headers used by apiFetch(java.lang.String, java.util.Map, java.lang.String, java.lang.String).
original_headers
- A Map of user-provided headers when making an API
call.