league / fractal-serializer-jsonapi
Handle the output of complex data structures ready for API output.
Requires
- php: >=7.2
- ext-json: *
Requires (Dev)
- league/fractal: ~1.0|1.0.x-dev
- mockery/mockery: ~1.0
- phpstan/phpstan: ^0.11.8
- phpunit/phpunit: ~8.0
- squizlabs/php_codesniffer: ~3.4
Suggests
- league/fractal: The engine that powers this serializer
Conflicts
- league/fractal: <1.0
This package is auto-updated.
Last update: 2024-10-29 05:23:05 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.
Install
Via Composer
$ composer require league/fractal-serializer-jsonapi
Requirements
The following versions of PHP are supported by this version.
- PHP 7.2
- PHP 7.3
- PHP 7.4
- HHVM
Documentation
Fractal has full documentation, powered by Jekyll.
Contribute to this documentation in the gh-pages branch.
License
The MIT License (MIT). Please see License File for more information.