myerscode/laravel-api-response

A fluent helper and facade to ensure consistent, idempotent API responses in Laravel and Lumen

Laravel API Response

A fluent helper to provide a consistent shaped API responses in Laravel, _(*1)

, _(*2)

Why is this package helpful?

This package ensures your API will always return the same envelope shape, so consuming apps always know what to expect!, _(*3)

Install

You can install this package via composer:, _(*4)

``` bash composer require myerscode/laravel-api-response, <sub>(*5)</sub>

## Usage

In a Laravel controller you just to build up your response and return it! 

The `api()` helper return a Response `Builder` and as it implements the [Responsable](https://laravel.com/api/master/Illuminate/Contracts/Support/Responsable.html) 
trait you dont need to do anything more than return the builder

### Using the api() helper function
```php
function resource()
{
    return api()->status(201)->data(['name' => 'Foo Bar'])->message('Record Created!');
}

Using a Builder class

function resource() {
    $buillder = new Builder();
    $builder->status(201)->data(['name' => 'Foo Bar'])->message('Record Created!');
    return $builder;
}

Would return the following JSON response., <sub>(*6)</sub>

{
    "status": 201,
    "data": {
        "name": "Foo Bar"
    },
    "meta": [],
    "messages": [
        "Record Created!"
    ]
}

License

The MIT License (MIT). Please see License File for more information., <sub>(*7)</sub>