lykegenes / laravel-api-response
thephpleague的Fractal包的Laravel封装
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.*
This package is auto-updated.
Last update: 2024-09-18 03:48:03 UTC
README
thephpleague的Fractal包的Laravel封装
安装
通过Composer
composer require lykegenes/laravel-api-response
然后,将以下内容添加到您的服务提供者中
Lykegenes\ApiResponse\ServiceProvider::class,
...并将以下内容添加到您的别名中
'ApiResponse' => Lykegenes\ApiResponse\Facades\ApiResponse::class,
可选地,您可以发布和编辑配置文件
php artisan vendor:publish --provider="Lykegenes\ApiResponse\ServiceProvider" --tag=config
使用方法
使用此包最简单的方法是从外观中调用make()函数。它将尝试猜测您的输入。有关转换器,请参阅Fractal包的文档此处。
// 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);
测试
composer test
致谢
许可证
MIT许可证(MIT)。有关更多信息,请参阅许可证文件。