Skip to content
A Laravel wrapper for thephpleague's Fractal package
PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
src
tests
.gitattributes
.gitignore
.scrutinizer.yml
.travis.yml
CHANGELOG.md
LICENSE.md
README.md
composer.json
phpunit.xml

README.md

laravel-api-response

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

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

License

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

You can’t perform that action at this time.