boomerang / boomerang
The Boomerang API Endpoint Testing Framework.
Requires
- php: >=7.4
- composer-runtime-api: ^2.0
- ext-curl: *
- ext-json: *
- ext-spl: *
- donatj/cli-toolkit: ~0.3
- donatj/flags: ~1
Requires (Dev)
- corpus/coding-standard: ^0.10
- donatj/drop: *
- donatj/mock-webserver: ~2.10
- friendsofphp/php-cs-fixer: =3.95.18
- phpstan/phpstan: 2.2.7
- phpunit/phpunit: ^9
- ralouphie/getallheaders: ^3.0
- squizlabs/php_codesniffer: ^4.0
This package is auto-updated.
Last update: 2026-08-10 19:24:08 UTC
README
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