nordsoftware / lumen-fractal
此包已被弃用且不再维护。没有建议的替代包。
Lumen PHP框架的分形模块。
1.3.0
2016-04-14 10:31 UTC
Requires
- php: >=5.6
- league/fractal: ^0.13
Requires (Dev)
- codeception/codeception: ^2.1
- codeception/specify: ^0.4.3
- codeception/verify: ^0.3.0
- laravel/lumen-framework: ^5.1
- satooshi/php-coveralls: ^1.0
This package is not auto-updated.
Last update: 2020-01-16 23:19:37 UTC
README
Fractal模块,用于Lumen PHP框架。
要求
设置
安装
运行以下命令通过Composer安装包
composer require nordsoftware/lumen-fractal
配置
将配置模板从config/fractal.php
复制到您的应用程序的config
目录中,并根据需要修改。更多信息请参阅Lumen文档中的配置文件部分。
可用的配置选项
- default_serializer - 默认序列化器,默认为null
引导
将以下行添加到bootstrap/app.php
$app->register('Nord\Lumen\Fractal\FractalServiceProvider');
您还可以可选地使用Nord\Lumen\Fractal\FractalMiddleware
来自动解析请求中的包含。
$app->middleware([ ..... 'Nord\Lumen\Fractal\Middleware\FractalMiddleware', ]);
使用方法
现在您可以在应用程序的任何地方使用Nord\Lumen\Fractal\FractalService
来访问Fractal。
以下是一些关于如果您使用Eloquent如何序列化数据的示例
public function getBook(FractalService $fractal, $id) { // load the book model ... return response()->json($fractal->item($book, new BookTransformer)->toArray()); }
public function listBooks(FractalService $fractal) { // load the book collection ... return response()->json($fractal->collection($books, new BookTransformer)->toArray()); }
贡献
请阅读指南。
运行测试
克隆项目,并运行以下命令安装其依赖项
composer install
运行以下命令来运行测试套件
vendor/bin/codecept run unit
许可
MIT,请参阅LICENSE。