Service | R Documentation |
RESTful service constructor
Service(
service,
host,
config = httr::config(),
authenticate = TRUE,
api_url = character(),
package = "AnVIL",
schemes = "https",
api_reference_url = api_url,
api_reference_md5sum = character(),
api_reference_headers = NULL
)
service |
character(1) The |
host |
character(1) host name that provides the API resource,
e.g., |
config |
httr::config() curl options |
authenticate |
logical(1) use credentials from authentication service file 'auth.json' in the specified package? |
api_url |
optional character(1) url location of OpenAPI
|
package |
character(1) (default |
schemes |
character(1) (default 'https') Specifies the transfer protocol supported by the API service. |
api_reference_url |
character(1) path to reference API. See Details. |
api_reference_md5sum |
character(1) the result of
|
api_reference_headers |
character() header(s) to be used
(e.g., |
This function creates a RESTful interface to a service
provided by a host, e.g., "api.firecloud.org". The function
requires an OpenAPI .json
or .yaml
specifcation as well as
an (optional) .json
authentication token. These files are
located in the source directory of a pacakge, at
<package>/inst/service/<service>/api.json
and
<package>/inst/service/<service>/auth.json
, or at api_url
.
When provided, the api_reference_md5sum
is used to check that
the file described at api_reference_url
has the same checksum
as an author-validated version.
The service is usually a singleton, created at the package
level during .onLoad()
.
An object of class Service
.
.MyService <- setClass("MyService", contains = "Service")
MyService <- function() {
.MyService(Service("my_service", host="my.api.org"))
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.