JsonApi is a PHP library to manage {json:api} documents. The library also offers the possiblity to manage an http response directly from the library.
Composer:
composer require carlonicora/jsonapiGit:
git clone https://github.com/carlonicora/jsonapi.gitThe JsonApi library does not require any configuration.
The library comes with a docker environment included. Useful for testing changes and running PHPUnit tests.
cd .docker
docker-compose build
docker-compose up -d
docker exec -ti jsonapi composer updateThis library is organised around the objects identifiable in the {json:api} documentation.
The main object is the document object, which gives you access to the main elements a {json:api} document can contain.
use \CarloNicora\JsonApi\document;
$document = new Document();You can also import a {json:api} document from an array.
use \CarloNicora\JsonApi\Document;
$array = [
'data' => [
'type' => 'journal',
'id' => 'andsjad897asd',
'attributes' => [
'title' => 'About phlow - the community media movement'
],
'links' => [
'self' => 'https://app.phlow.com/@carlo/journals/about-phlow-the-community-media-movement'
],
'relationships' => [
'author' => [
'links' => [
'related' => 'https://app.phlow.com/@carlo'
],
'data' => [
'type' => 'user',
'id' => 'adslau79ulaksdu',
'meta' => [
'isPrimaryAuthor' => true
]
]
],
'images' => [
'data' => [
[
'type' => 'image',
'id' => '26037dd7-481b-4110-97f3-a879a08d1e20',
'meta' => [
'isCover' => true
]
],
[
'type' => 'image',
'id' => '2563cc0c-3202-4554-be70-3c9850d5369e',
'meta' => [
'isCover' => false
]
]
]
]
]
],
'included' => [
[
'type' => 'user',
'id' => 'adslau79ulaksdu',
'attributes' => [
'name' => 'Carlo Nicora',
'username' => 'carlo',
'url' => 'https://carlonicora.com'
],
'meta' => [
'hasJournals' => true,
'hasPhotos' => true
],
'links' => [
'self' => 'https://app.phlow.com/@carlo'
]
],
[
'type' => 'image',
'id' => '26037dd7-481b-4110-97f3-a879a08d1e20',
'attributes' => [
'url' => 'https://acc-phlow.imgix.net/wZaN92gl7WlRmDWrKp/26037dd7-481b-4110-97f3-a879a08d1e20.jpg?w=750&ixlib=js-1.1.0&s=28c961bf9a05855320fe853155b1cd7f'
],
'links' => [
'self' => 'https://acc-phlow.imgix.net/wZaN92gl7WlRmDWrKp/26037dd7-481b-4110-97f3-a879a08d1e20.jpg?w=750&ixlib=js-1.1.0&s=28c961bf9a05855320fe853155b1cd7f'
]
],
[
'type' => 'image',
'id' => '2563cc0c-3202-4554-be70-3c9850d5369e',
'attributes' => [
'url' => 'https://acc-phlow.imgix.net/wZaN92gl7WlRmDWrKp/2563cc0c-3202-4554-be70-3c9850d5369e.jpg?w=750&ixlib=js-1.1.0&s=da188c73f2b571d1afd9b1625f482e05'
],
'links' => [
'self' => 'https://acc-phlow.imgix.net/wZaN92gl7WlRmDWrKp/2563cc0c-3202-4554-be70-3c9850d5369e.jpg?w=750&ixlib=js-1.1.0&s=da188c73f2b571d1afd9b1625f482e05'
]
]
]
];
$document = new Document($array);A resourceObject is a {json:api} document primary data. The document object can contain multiple resourceObject.
use \CarloNicora\JsonApi\Objects\ResourceObject;
use \CarloNicora\JsonApi\Objects\Link;
$resource = new ResourceObject('journal', 'iajhd80');
$resource->attributes->add('title', 'About phlow - the community media movement');
$resource->links->add(new Link('self', 'https://app.phlow.com/@carlo/journals/about-phlow-the-community-media-movement'));As for the document, a resourceObject can be populated by passing an array.
use \CarloNicora\JsonApi\Objects\ResourceObject;
$array = [
'type' => 'journal',
'id' => 'andsjad897asd',
'attributes' => [
'title' => 'About phlow - the community media movement'
],
'links' => [
'self' => 'https://app.phlow.com/@carlo/journals/about-phlow-the-community-media-movement'
]
];
$resource = new ResourceObject(null, null, $array);A resourceObject can contain multiple relationship, as defined in the {json:api} documentation.
use \CarloNicora\JsonApi\Objects\ResourceObject;
$resource = new ResourceObject('journal', '1');
$userResource = new ResourceObject('user', '10');
$resource->relationship('author')->resourceLinkage->add($userResource);This project use Semantic Versioning for its tags.
Please, feel free to contribute, fork the repo and submit PR.
This project is licensed under the MIT license - see the LICENSE.md file for details
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent