tattran22/response

此软件包最新版本（2.0.4）没有可用的许可证信息。

Laravel的API响应转换简化工具

维护者

详细信息

github.com/TatTran22/response

源代码

安装: 5

依赖项: 0

建议者: 0

安全: 0

星星: 0

关注者: 0

分支: 1

2.0.4 2024-03-28 08:14 UTC

Requires

Unknown License 294392e968553822612623ecebd13cb17728b596

  • Tất Trần <tattran.dev.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-28 09:28:54 UTC

README

此Laravel软件包简化了使用Fractal库处理API响应的过程。它允许您轻松：

  • 转换数据：将原始数据转换为结构化响应。
  • 包含关系：在不进行单独请求的情况下向响应中添加相关数据。
  • 处理分页：自动添加分页链接和元数据。

安装

只需在您的终端运行此命令

composer require tattran22/response

用法

  1. 准备您的数据：使用Eloquent模型、数组或任何合适的格式。
  2. 创建转换器：使用ResponseTransformer类定义如何转换您的数据。
  3. 转换您的数据：使用您的数据和转换器调用transformData。
    use TatTran\Response\Transformers\ResponseTransformer;

$transformer = new ResponseTransformer($manager);
$response = $transformer->transformData($data, $transformerInstance);
  4. （可选）包含关系：将include参数添加到您的API请求中（例如，?include=relationship）。
    $transformer->setIncludes(['include1', 'include2']);

功能

  • 易于转换：在清晰、易读的代码中定义转换。
  • 包含解析：自动处理include查询参数。
  • 分页支持：无缝添加分页链接和元数据。
  • 程序设置包含：在代码中控制包含的关系。

开源 & 致谢

此软件包在MIT许可下免费使用，由Tat Tran开发。