Tests for RESTful APIs using HAL+JSON media type

This project provide common tests for REST APIs that use the JSON Hypertext Application Language Media Type. Provided tests are meant to be used with the AVA JavaScript test runner and employ the SuperTest HTTP assertion library.

Installation

rest-hal-test-tools runs on Node.js and is available as an NPM package. You can install rest-hal-test-tools in your project's directory as usual:

npm install @yeiniel/rest-hal-test-tools --save-dev

Reference Documentation

Reference documentation for this project can be generated from the inline comments on source code using the Typedoc documentation generator. The following command ease the task:

npm run typedoc

Typescript Support

This package is written in Typescript and it provide a declaration file for its content so you can use it on Typescript projects without problems.

Licensing

The code in this project is licensed under MIT license.