league / fractal
Handle the output of complex data structures ready for API output.
Installs: 50 326 438
Dependents: 539
Suggesters: 108
Security: 0
Stars: 3 521
Watchers: 90
Forks: 351
Open Issues: 58
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-11-07 19:39:54 UTC
README
Fractal provides a presentation and transformation layer for complex data output, the like found in RESTful APIs, and works really well with JSON. Think of this as a view layer for your JSON/YAML/etc.
When building an API it is common for people to just grab stuff from the database and pass it
to json_encode(). This might be passable for "trivial" APIs but if they are in use by the public,
or used by mobile applications then this will quickly lead to inconsistent output.
Goals
- Create a protective shield between source data and output, so schema changes do not affect users
- Systematic type-casting of data, to avoid
foreach()ing through and(bool)ing everything - Include (a.k.a embedding, nesting or side-loading) relationships for complex data structures
- Work with standards like HAL and JSON-API but also allow custom serialization
- Support the pagination of data results, for small and large data sets alike
- Generally ease the subtle complexities of outputting data in a non-trivial API
This package is compliant with PSR-1, PSR-2 and PSR-4. If you notice compliance oversights, please send a patch via pull request.
Install
Via Composer
$ composer require league/fractal
Requirements
The following versions of PHP are supported by this version:
>= PHP 7.4
Documentation
Fractal has full documentation, powered by Jekyll.
Contribute to this documentation in the gh-pages branch.
Todo
- add HAL serializers
Testing
$ phpunit
Contributing
Please see CONTRIBUTING and CONDUCT for details.
Maintainers
Credits
License
The MIT License (MIT). Please see License File for more information.