Travhaller
A simple HAL+JSON API Client (Work in Progress)
Install
travhaller is available as npm module:
npm install travhaller
It can be used in NodeJS or in browsers via browserify:
var travhaller = ;
Usage
Creating a Travhaller Node
travhaller
You will have to do this once, to define your entry point. The URL needs to be the root of the API. if it is not, you have to specify the root explicitly:
travhaller
Creating a Node will automatically query the API, returning a Promise to a Travhaller Node.
For example:
var rootEntryPointPromise = travhaller; var depperEntryPointPromise = travhaller;
Using the Travhaller Node
Once you have a Node, you can start exploring the API:
The getResource()
method allows you to get the actual API Response. With follow()
you can follow a link of that node to get another Node. If an _embedded Resource with the given name exists, it will be used (unless the useEmbedded
Parameter of follow()
is set to false) instead of querying the server, as specified in the HAL+JSON Draft
For example:
// Get the Root Resourcetravhaller;
Future Plans
Travhaller is very much work in progress and more of a concept study than actually useful, certainly not production ready. I do however intend to expand and add to this. The current version of Travhaller is read-only, but it won't stay that way.
If you have any issues or suggestions feel free to let me know!