A Hypermedia API/HATEOAS Client for Node.js and the Browser
Clone or download
Permalink
Failed to load latest commit information.
.github/ISSUE_TEMPLATE chore(github): create issue templates Sep 9, 2018
bin update sizes.sh Feb 10, 2017
browser update repository name after move Mar 25, 2017
lib fix(http): fix error message for convertResponseToObject case Sep 13, 2018
misc/logo add logo to user guide and api Mar 27, 2017
test fix(http): fix error message for convertResponseToObject case Sep 13, 2018
.commitlintrc.js chore(husky): defined hooks for `pre-commit` and `commit-msg` Sep 10, 2018
.editorconfig add .editorconfig Feb 26, 2015
.gitattributes add logo to user guide and api Mar 27, 2017
.gitignore add .node-version to .gitignore [skip-ci] May 4, 2016
.huskyrc.json chore(husky): defined hooks for `pre-commit` and `commit-msg` Sep 10, 2018
.jshintrc semicolons Jun 28, 2014
.npmignore cleanup Mar 28, 2015
.nvmrc chore(build): add .nvmrc Jul 22, 2018
.travis.yml add explicit npm install back to avoid npm ci because of greenkeeper Jul 26, 2018
CHANGELOG.md release 6.1.1 Sep 14, 2018
CODE_OF_CONDUCT.md docs(contributing): add contribution guidelines and code of conduct Sep 9, 2018
CONTRIBUTING.md docs(contributing): add contribution guidelines and code of conduct Sep 9, 2018
Gruntfile.js chore(build): replace grunt-mocha-phantomjs by grunt-mocha May 3, 2016
LICENSE add license file Nov 17, 2013
api.markdown feat(serialization): offer option to omit stringification Jul 26, 2018
bower.json release 6.1.1 Sep 14, 2018
howto_release.markdown release 6.1.1 Sep 14, 2018
package-lock.json chore(package): update lockfile package-lock.json Sep 23, 2018
package.json chore(package): update grunt-contrib-jshint to version 2.0.0 Sep 23, 2018
readme.markdown docs(contributing): add contribution guidelines and code of conduct Sep 9, 2018
refactor.markdown update todos Mar 20, 2015
todo.markdown update todos Mar 20, 2015
traverson.js update repository name after move Mar 25, 2017
user-guide.markdown docs(userguide): fix TypeScript types links Sep 8, 2018

readme.markdown

Traverson Logo

Traverson

A Hypermedia API/HATEOAS Client for Node.js and the Browser

Build Status Dependency Status NPM Greenkeeper badge

File Size (browser build) KB
minified & gzipped 17
minified 61

Quick Links

Introduction

Traverson comes in handy when consuming REST APIs that follow the HATEOAS principle, that is, REST APIs that have links between their resources. Such an API (also sometimes referred to as hypermedia or hypertext-driven API) typically has a root resource/endpoint, which publishes links to other resources. These resources in turn might also have, as part of their metadata, links to related resources. Sometimes you need to follow multiple consecutive links to get to the resource you want. This pattern makes it unnecessary for the client to hardcode all endpoint URLs of the API it uses, which in turn reduces the coupling between the API provider and the API consumer. This makes it easier for the API provider to change the structure of the API without breaking existing client implementations.

To follow a path of links you typically start at one URL (most often the root URL of the API), then look for the link you are interested in, fetch the document from there and repeat this process until you have reached the end of this path.

Traverson does that for you. You just need to tell Traverson where it can find the link to follow in each consecutive document and Traverson will happily execute the hops from document to document for you and when it's done, hand you the final http response or document, the one you really wanted to have in the first place.

Traverson works in Node.js and in the browser. For now, Traverson only supports JSON APIs. Support for other specialized JSON hypermedia types can be added with plug-ins (for example JSON-HAL).

The most basic thing you can do with traverson is to let it start at the root URL of an API, follow some links and pass the resource that is found at the end of this journey back to you. We call this procedure a "link traversal process". Here's how:

var traverson = require('traverson');

traverson
.from('http://api.example.com')
.follow('link_to', 'resource')
.getResource(function(error, document) {
  if (error) {
    console.error('No luck :-)')
  } else {
    console.log('We have followed the path and reached the target resource.')
    console.log(JSON.stringify(document))
  }
});

The User Guide has a ton of examples of what else Traverson can do for you. Here are some highlights:

  • resolve URI Templates
  • use JSONPath
  • manage headers, query strings and authentication (including OAuth)
  • content type detection
  • work with different media types by using plug-ins
  • use a custom JSON parser
  • continuing link traversals

License

MIT