https://github.com/donatj/boomerang

API Endpoint E2E Testing Application
https://github.com/donatj/boomerang

api-testing php testing

Last synced: 10 months ago
JSON representation

API Endpoint E2E Testing Application

• Host: GitHub
• URL: https://github.com/donatj/boomerang
• Owner: donatj
• License: mit
• Created: 2013-08-21T22:08:55.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2024-11-24T12:28:51.000Z (over 1 year ago)
• Last Synced: 2025-04-14T03:15:03.843Z (about 1 year ago)
• Topics: api-testing, php, testing
• Language: PHP
• Homepage: http://boomerang.work
• Size: 449 KB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Boomerang!

[![Latest Stable Version](https://poser.pugx.org/boomerang/boomerang/v/stable.svg)](https://packagist.org/packages/boomerang/boomerang)

[![Total Downloads](https://poser.pugx.org/boomerang/boomerang/downloads.svg)](https://packagist.org/packages/boomerang/boomerang) 

[![Latest Unstable Version](https://poser.pugx.org/boomerang/boomerang/v/unstable.svg)](https://packagist.org/packages/boomerang/boomerang)

[![License](https://poser.pugx.org/boomerang/boomerang/license.svg)](https://packagist.org/packages/boomerang/boomerang)

![CI](https://github.com/donatj/Boomerang/workflows/CI/badge.svg)

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 5.4.0+ with CLI and SPL

- *nix or cygwin on windows.

## Installation

Using composer, `boomerang` can be installed globally via: 

```bash

$ composer global require 'boomerang/boomerang'

```

Or if you are using composer for the project you wish to test, you can simply add it as a [vendor binary](https://getcomposer.org/doc/articles/vendor-binaries.md):

```json

{

  "require-dev": {

      "boomerang/boomerang": "~0.2.0"

  }

}

```

## Development

```bash

$ git clone https://github.com/donatj/Boomerang.git Boomerang

$ cd Boomerang

$ composer.phar install

```

### Basic Execution

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

From the root of the cloned project, execute 

```bash

$ ./vendor/bin/boomerang

```

### Building a Phar

You will need Composer to fetch the requirements

```bash

$ php create-phar.php

```