esandex
v0.0.3
Published
A lightweight sandbox representation of the Esendex REST API.
Downloads
11
Readme
Esandex
A lightweight sandbox implementation of the Esendex REST API, providing request and response schema validation with example response behaviour and content. Currently all examples are taken from the official REST API documentation, with the goal of eventually adding sandboxed features that modify these example responses for expected scenarios.
Getting Started
You can consume the sandbox in one of two ways: as a standalone server or as a package.
Standalone Server
Install the sandbox globally:
$ npm install esandex -g
Start the sandbox:
$ esandex
Esandex: started sandbox on port 3000
Use In Code
To consume the sandbox as a package, require
the module and start the server:
var esandex = require('esandex');
var sandbox = esandex.create();
sandbox.listen(3000, function () {
console.log('sandbox started at http://localhost:3000/');
}