lykegenes/laravel-api-response

A Laravel wrapper for thephpleague's Fractal package

laravel-api-response

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

A Laravel wrapper for thephpleague's Fractal package, _(*2)

Install

Via Composer, _(*3)

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

Then, add this to your Service Providers :
``` php
Lykegenes\ApiResponse\ServiceProvider::class,

...and this to your Aliases : ``` php 'ApiResponse' => Lykegenes\ApiResponse\Facades\ApiResponse::class,, <sub>(*5)</sub>

Optionally, you can publish and edit the configuration file :
``` bash
php artisan vendor:publish --provider="Lykegenes\ApiResponse\ServiceProvider" --tag=config

Usage

The easiest way to use this package is to call the make() function from the facade. It will try to guess your input. For the transformers, see the docs from the Fractal package here. ``` php // You can use a class directly to return a paginated collection return ApiResponse::make(User::class, UserTransformer::class);, <sub>(*6)</sub>

// You can also use an Eloquent Query return ApiResponse::make(User::where('age', '<', '40'), UserTransformer::class);, <sub>(*7)</sub>

// This will return a single object return ApiResponse::make(User::findOrFail($id), UserTransformer::class);, <sub>(*8)</sub>

## Testing

``` bash
composer test

Credits

• Patrick Samson
• All Contributors

License

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