boomerang/boomerang

The Boomerang API Endpoint Testing Framework.

Maintainers

Package info

github.com/donatj/Boomerang

Homepage

pkg:composer/boomerang/boomerang

Transparency log

Statistics

Installs: 95 649

Dependents: 0

Suggesters: 0

Stars: 7

Open Issues: 4


README

Latest Stable Version Total Downloads Latest Unstable Version License CI

Boomerang! is a simple Frisby.js inspired API E2E endpoint testing framework, providing the tools you need to validate REST responses.

Boomerang! consumes your API and validates your defined set of expectations, alerting you to any problems that arise.

Boomerang! is still in active development and more info is coming soon!

Documentation and more information is availible at http://boomerang.work/

Requirements

  • PHP 7.4+ with the CLI, cURL, SPL, and JSON extensions
  • A Unix-like environment (or Cygwin on Windows)

Continuous integration tests PHP 7.4 through PHP 8.5.

Installation

Using composer, boomerang can be installed globally via:

$ composer global require 'boomerang/boomerang'

Or add it to the project you wish to test as a vendor binary:

$ composer require --dev boomerang/boomerang

Development

$ git clone https://github.com/donatj/Boomerang.git Boomerang
$ cd Boomerang
$ composer install

Basic Execution

The easiest way to test is simply using the composer executable.

From the root of the cloned project, execute

$ ./vendor/bin/boomerang

Building a Phar

You will need Composer to fetch the requirements

$ php create-phar.php