bluecat

Bluecat

A REST API testing framework built on node.js that makes testing API endpoints straightforward.

• Define your APIs in a json file, Bluecat will create all the methods for you
• Callbacks are removed so tests that have a complex API call flow will be more clear
• Full control over the request URL query, headers and body in test case
• Automatically maintains session cookies for you for HTTP API call flows

Installation

$ npm install bluecat

Simple Sample Usage

• First define your API in config/api.json:

{
  "mobileapi": {
    "typeahead": {
      "schema": "http",
      "method": ["GET"]
      }
  }
}

• Then in your test suite (example, using Mocha):

var expect = require('chai').expect;
var Bluecat = require('bluecat');
var Api = Bluecat.Api('mobileapi');

describe('typeahead service test suite', function() {

  before(function() {
    t = new Bluecat.ServiceSync(Api, 'mobile.walmart.com');
  })

  it('typeahead?term=toy&cat=0&num=8', function(done) {
    t.run(function() {
      // send GET to typeahead?term=toy&cat=0&num=8
      var r = t.typeahead.GET({
        term: 'xbox',
        cat: 8,
        num: 0
      });

      // verify response
      expect(r.err).to.equal(null);
      expect(r.data.statusCode).to.equal(200);
      expect(r.data.body).to.have.ownProperty('specific');
      done();
    })
  })
})

License

Licensed under the MIT