laravel-api-response
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.
2k Dec 22, 2022
2 Oct 12, 2022
18 Dec 14, 2022
2 May 2, 2022
3 Sep 10, 2022
10 Dec 20, 2022
5 Jun 14, 2023
2.8k Jan 7, 2023
15 Dec 27, 2022
10 Nov 13, 2022
4 Jan 18, 2022
87 Dec 7, 2022
44 Dec 8, 2022
21 Nov 23, 2021
796 Jan 8, 2023
22 May 1, 2022
2 Mar 24, 2022
24 Nov 20, 2022
4 Feb 28, 2022