league / fractal
处理复杂数据结构的输出,以便于API输出。
0.20.1
2022-04-11 12:47 UTC
Requires
- php: >=7.4
Requires (Dev)
- doctrine/orm: ^2.5
- illuminate/contracts: ~5.0
- mockery/mockery: ^1.3
- pagerfanta/pagerfanta: ~1.0.0
- phpstan/phpstan: ^1.4
- phpunit/phpunit: ^9.5
- squizlabs/php_codesniffer: ~3.4
- vimeo/psalm: ^4.22
- zendframework/zend-paginator: ~2.3
Suggests
- illuminate/pagination: The Illuminate Pagination component.
- pagerfanta/pagerfanta: Pagerfanta Paginator
- zendframework/zend-paginator: Zend Framework Paginator
- 1.0.x-dev
- dev-master / 0.20.x-dev
- 0.20.1
- 0.20
- 0.19.2
- 0.19.1
- 0.19
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.9.0
- 0.8.3
- 0.8.2
- 0.8.1
- 0.8.0
- 0.7.0
- 0.6.1
- 0.6.0
- 0.5.1
- 0.5.0
- 0.4.6
- 0.4.5
- 0.4.4
- 0.4.3
- 0.4.2
- 0.4.0
- 0.3.1
- 0.3.0
- 0.2.1
- 0.2.0
- 0.1.0
- 0.0.1
- dev-fix/551-null-values-for-data-arrays
- dev-add-static-analysis
This package is auto-updated.
Last update: 2024-09-11 18:09:15 UTC
README
Fractal为复杂数据输出提供了一个展示和转换层,例如在RESTful API中找到的,并且与JSON配合得非常好。将其视为JSON/YAML等的数据视图层。
在构建API时,人们通常会直接从数据库中抓取内容并传递给json_encode()
。这可能适用于“简单”API,但如果它们被公众使用或被移动应用程序使用,这会导致输出不一致。
目标
- 在源数据和输出之间创建一个保护层,以便架构更改不会影响用户
- 系统地类型转换数据,以避免使用
foreach()
和(bool)
遍历一切 - 为复杂数据结构包含(即嵌入、嵌套或侧加载)关系
- 与HAL和JSON-API等标准配合,但同时也允许自定义序列化
- 支持数据结果的分页,适用于小型和大型数据集
- 通常简化了非平凡API中输出数据的微妙复杂性
此软件包符合PSR-1、PSR-2和PSR-4。如果您注意到合规性疏忽,请通过pull request发送补丁。
安装
通过Composer
$ composer require league/fractal
要求
以下PHP版本支持此版本
>= PHP 7.4
文档
在gh-pages分支中为此文档做出贡献。
待办事项
- 添加HAL序列化器
测试
$ phpunit
贡献
请参阅CONTRIBUTING和CONDUCT以获取详细信息。
维护者
鸣谢
许可
MIT许可(MIT)。有关更多信息,请参阅许可文件。