pixelfed / fractal
处理复杂数据结构的输出,以便于API输出。
0.18.0
2018-07-01 02:30 UTC
Requires
- php: >=5.4
Requires (Dev)
- doctrine/orm: ^2.5
- illuminate/contracts: ~5.0
- mockery/mockery: ~0.9
- pagerfanta/pagerfanta: ~1.0.0
- phpunit/phpunit: ^4.8.35
- squizlabs/php_codesniffer: ~1.5
- zendframework/zend-paginator: ~2.3
Suggests
- illuminate/pagination: The Illuminate Pagination component.
- pagerfanta/pagerfanta: Pagerfanta Paginator
- zendframework/zend-paginator: Zend Framework Paginator
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- dev-master / 0.13.x-dev
- 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-mediaholding-improved-json-api-support
- dev-scrutinizer
- dev-improved-l4-paginator
This package is auto-updated.
Last update: 2024-09-11 19:41:05 UTC
README
Fractal 为复杂数据输出提供了一种表示和转换层,类似于 RESTful API 中的输出,并且与 JSON 工作得非常好。将其视为 JSON/YAML 等的视图层。
在构建 API 时,人们通常会直接从数据库中获取内容并传递给 json_encode()
。这可能对“简单”的 API 来说是可行的,但如果它们被公众使用,或者被移动应用使用,那么这很快就会导致输出不一致。
目标
- 创建一个保护层,在源数据与输出之间,以便模式更改不会影响用户
- 对数据进行系统性的类型转换,以避免通过
foreach()
遍历和将所有内容转换为(bool)
- 包括(也称为嵌入、嵌套或侧加载)复杂数据结构的关系
- 与 HAL 和 JSON-API 等标准一起工作,但也允许自定义序列化
- 支持数据结果的分页,适用于小型和大型数据集
- 通常简化了在非平凡 API 中输出数据的微妙复杂性
此包符合 PSR-1、PSR-2 和 PSR-4。如果您发现符合性疏忽,请通过拉取请求发送补丁。
安装
通过 Composer
$ composer require league/fractal
需求
此版本支持以下版本的 PHP。
- PHP 5.4
- PHP 5.5
- PHP 5.6
- PHP 7.0
- PHP 7.1
- HHVM
文档
在 gh-pages 分支 中为该文档做出贡献。
待办事项
- 添加 HAL 序列化器
测试
$ phpunit
贡献
请参阅 CONTRIBUTING 和 CONDUCT 以获取详细信息。
鸣谢
许可
MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件。