Description
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.
Fractal alternatives and similar libraries
Based on the "Data Structure and Storage" category.
Alternatively, view Fractal alternatives based on common mentions on social networks and blogs.
-
Porter
:lipstick: Durable and asynchronous data imports for consuming data at scale and publishing testable SDKs. -
Cake Collection
[READ-ONLY] Collection library in CakePHP. This repo is a split of the main code that can be found in https://github.com/cakephp/cakephp -
CRUDlex
CRUDlex is an easy to use CRUD generator for Symfony 4 and Silex 2 which is great for auto generated admin pages -
Cloudways' Black Friday Offer - 1st Choice of Developers
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of Fractal or a related project?
README
Fractal
[
](LICENSE)
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.
*Note that all licence references and agreements mentioned in the Fractal README section above
are relevant to that project's source code only.