vice/laravel-fractal

Laravel 5 的 Fractal 辅助工具

v0.1.1 2016-07-13 11:26 UTC

This package is not auto-updated.

Last update: 2024-09-14 19:25:41 UTC


README

Latest Version on Packagist Build Status Software License

Fractal 允许您通过充当前端和后端之间的反腐败层,以一致的方式呈现 API 数据。

在这里了解有关 Fractal 的更多信息。

安装

需要此包

composer require vice/laravel-fractal

然后,将以下内容添加到 app.php 中的服务提供者

Vice\LaravelFractal\FractalServiceProvider::class,

用法

要向前端发送单个实体的 JSON 表示,只需

public function show($id)
{
    //...

    fractalResponse()->item($thing, new ThingTransformer);
}

要向前端发送实体集合的 JSON 表示,只需

public function index()
{
    //...

    fractalResponse()->collection($things, new ThingTransformer);
}

集合方法还支持分页器,并将它们的状态自动附加到 meta 键下

如果您需要在不立即用于响应的情况下转换数据,您可以将 Vice\LaravelFractal\FractalService 注入到您的控制器/类中,并按如下方式使用它

$json = $this->fractalService->item($thing, new ThingTransformer)->toJson();

贡献

请在任何 GitHub 上打开任何问题或拉取请求。此包由 max.brokman@vice.com 维护

对于 PR,请在提交之前运行样式修复器(vendor/bin/php-cs-fixer fix)。