league/fractal

处理复杂数据结构的输出,以便于API输出。

安装量: 48,915,720

依赖关系: 544

建议者: 108

安全: 0

星标: 3,526

关注者: 90

分支: 351

开放问题: 58

0.20.1 2022-04-11 12:47 UTC

README

Latest Version Software License The PHP League Tests Total Downloads

Fractal为复杂数据输出提供了一个展示和转换层,例如在RESTful API中找到的,并且与JSON配合得非常好。将其视为JSON/YAML等的数据视图层。

在构建API时,人们通常会直接从数据库中抓取内容并传递给json_encode()。这可能适用于“简单”API,但如果它们被公众使用或被移动应用程序使用,这会导致输出不一致。

目标

  • 在源数据和输出之间创建一个保护层,以便架构更改不会影响用户
  • 系统地类型转换数据,以避免使用foreach()(bool)遍历一切
  • 为复杂数据结构包含(即嵌入、嵌套或侧加载)关系
  • 与HAL和JSON-API等标准配合,但同时也允许自定义序列化
  • 支持数据结果的分页,适用于小型和大型数据集
  • 通常简化了非平凡API中输出数据的微妙复杂性

此软件包符合PSR-1PSR-2PSR-4。如果您注意到合规性疏忽,请通过pull request发送补丁。

安装

通过Composer

$ composer require league/fractal

要求

以下PHP版本支持此版本

>= PHP 7.4

文档

Fractal有完整的文档,由Jekyll提供。

gh-pages分支中为此文档做出贡献。

待办事项

  • 添加HAL序列化器

测试

$ phpunit

贡献

请参阅CONTRIBUTINGCONDUCT以获取详细信息。

维护者

鸣谢

许可

MIT许可(MIT)。有关更多信息,请参阅许可文件