lykegenes/laravel-api-response

A Laravel wrapper for thephpleague's Fractal package

1.2.0 2015-10-27 18:27 UTC

Requires

• illuminate/database: ~5.1
• illuminate/http: ~5.1
• illuminate/support: ~5.1
• league/fractal: ^0.12.0

Requires (Dev)

• mockery/mockery: 0.9.*
• orchestra/testbench: ~3.0
• phpunit/phpunit: 4.*

MIT

• Patrick Samson

• api
• laravel
• fractal
• lykegenes
• laravel-api-response

README

A Laravel wrapper for thephpleague's Fractal package

Install

Via Composer

composer require lykegenes/laravel-api-response

Then, add this to your Service Providers :

Lykegenes\ApiResponse\ServiceProvider::class,

...and this to your Aliases :

'ApiResponse' => Lykegenes\ApiResponse\Facades\ApiResponse::class,

Optionally, you can publish and edit the configuration file :

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.

// You can use a class directly to return a paginated collection
return ApiResponse::make(User::class, UserTransformer::class);

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

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

Testing

composer test

Credits

• Patrick Samson
• All Contributors

License

The MIT License (MIT). Please see License File for more information.