Fork me on Github!


Boomerang! is an easy to use API surface testing framework. It is written in PHP and is composer compatible.

Inspired by Frisby.js, Boomerang! takes API testing a step further by allowing easy iteration of values, validation of individual hops along a set of redirects, all the while using a more reliable, extensible architecture.

Boomerang! uses semantic versioning, and is at major version 0, so the public API should not be considered stable.

What does it do?

Boomerang! tests your API by making HTTP requests to your API and validates the response body and headers.


Features In The Works

Does Boomerang! replace unit testing?

No, not at all. It is meant to be used in conjunction with a proper unit test suite for an enhanced test sweep.

What does a simple test look like?

Here is a simple sample that validates a response like { "origin": "" } where the IP address could be variable.


namespace Boomerang;

use Boomerang\TypeExpectations\RegexEx;

$req      = new HttpRequest('');  // Create the API Request
$response = $req->makeRequest();                       // Execute the request, return a Response object

$valid = new HttpResponseValidator($response);         // Create an HTTP response validator.
$valid->expectStatus(200)                              // State a HTTP 200 status expectation
      ->expectHeaderContains('Content-Type', 'json');  // State a Content-Type expectation

Boomerang::addValidator($valid);                       // Register the validator with Boomerang

$json = new JSONValidator($response);                  // Create a JSON Validator
    // Check that the 'origin' key matches a simple four dot IPv4 pattern.
    "origin" => new RegexEx('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/')

Boomerang::addValidator($json);                        // Register the validator with Boomerang