JS Hypermedia Client for several formats (HAL, Siren, etc)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
dist
src
test
tutorials
.doclets.yml
.editorconfig
.eslintrc.json
.gitignore
.hound.yml
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
bower.json
conf.json
gulpfile.js
index.js
karma.conf.js
package.json

README.md

hy-res Build Status Coverage Status

Sauce Test Status

A hypermedia client/library supporting several media formats. HAL, Siren, and Link header extensions are included by default, but support for other media types can be added. For the most part, the core library is not normally used directly, instead consumed by way of a small framework integration layer, e.g. angular-hy-res.

Support

For any questions, please post to the HyRes Google Group.

For release announcements and updates, you can also follow @petejohanson:

Follow @petejohanson <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>

Installation

NPM

hy-res is available via NPM. To install:

$ npm install --save hy-res

Note: The API is still evolving, so during the 0.0.x series of releases there are no API stability guarantees Those users needed a stable API should set an explicit version in package.json

Documentation

hy-res is inspired by AngularJS' $resource service that focuses on using hypermedia controls, links (and/or embedded resources) discovered by link relation, to traverse a hypermedia enabled API. hy-res itself is not dependant on AngularJS, and can be used standalone along w/ the axios library. For deep AngularJS integration, leveraging the $http service, use the angular-hy-res wrapper library.

For details, see refer to the API documentation.

Examples

A complete working example can be found at angular-hy-res-example, which demonstrates the below pagination concept. A public copy is deployed to Heroku at:

https://angular-hy-res-example.herokuapp.com/

For example, given a HAL collection resource that uses the standard link relations next and prev to control paging through the collection, and the item relation for each item in the collection, here is a sample response:

{
    "_links": {
        "self": { "href": "/page/2" },
        "next": { "href": "/page/3" },
        "prev": { "href": "/page/1" }
    },
    "_embedded": {
        "item": [
          {
            "_links": { "self": { "href": "/posts/123" } },
            "title": "MY blog post",
            "tags": [ "blogging", "hypermedia" ]
          }
        ]
    }
}

Then the controller can easily be:

angular.module('angularHyResDocs')
  .controller('ahrdPageCtrl', function(root) {
    $scope.page = root.$followOne('http://api.myserver.com/rel/posts');
    $scope.posts = $scope.page.$followAll('item');
    
    var follow = function(rel) {
      $scope.page = $scope.page.$followOne(rel);
      $scope.posts = $scope.page.$followAll('item');
    };
    
    $scope.next = function() {
      if (!$scope.hasNext()) {
        return;
      }
      
      follow('next');
    };
    
    $scope.prev = function() {
      if (!$scope.hasPrev()) {
        return;
      }
      
      follow('prev');
    };
    
    $scope.hasNext = function() {
      return $scope.page.$has('next');
    };
    
    $scope.hasPrev = function() {
      return $scope.page.$has('prev');
    };
  });

And the view:

<div>
  <ul class="pagination">
    <li>
      <a ng-click="{{prev()}}" ng-class="{disabled: !hasPrev()}">&laquo;</a>
    </li>
    <li>
      <a ng-click="{{next()}}" ng-class="{disabled: !hasNext()}">&raquo;</a>
    </li>
  </ul>
  <ul>
    <li ng-repeat="post in posts">{{post.title}}</li>
  </ul>
</div>

To Do

  • Submit form file uploads? Maybe allow consumers to provide populated FormData instance in submit parameters?
  • Handle scenario where subset of links for a given link relation is embedded. For this scenario, we should really return a mix of resolved embedded resources and unresolved resources that result from following the non-embedded links.
  • Extensions for other media types (e.g. Uber, Mason)
  • Support URI schemes other than http/https (extension mechanism?)
  • Mixins for resources based on... profile? link relation that was followed?
  • Differentiate between embedded link vs embedded representation (See Siren spec)
  • Handling or error types, e.g. application/problem+json
  • Support for PUT of modified resource to replace server state?

Thanks

Many thanks goes to JetBrains for their contribution of a WebStorm license to speed up development.