JSON API spec implemented in PHP 7. Immutable

The goal of this library is to ensure strict validity of JSON API documents being produced.

JSON:

{
    "data": {
        "type": "articles",
        "id": "1",
        "attributes": {
            "title": "Rails is Omakase"
        },
        "relationships": {
            "author": {
                "data": {
                    "type": "people",
                    "id": "9"
                },
                "links": {
                    "self": "/articles/1/relationships/author",
                    "related": "/articles/1/author"
                }
            }
        }
    }
}

PHP:

<?php
use JsonApiPhp\JsonApi\{
    DataDocument, SingleLinkage, Attribute, ResourceIdentifier, ResourceObject, Relationship,
    Link\RelatedLink, Link\SelfLink, Link\Url
};

echo json_encode(
    new DataDocument(
        new ResourceObject('articles', '1',
            new Attribute('title', 'Rails is Omakase'),
            new Relationship('author',
                new SingleLinkage(new ResourceIdentifier('author', '9')),
                new SelfLink(new Url('/articles/1/relationships/author')),
                new RelatedLink(new Url('/articles/1/author'))
            )
        )
    ),
    JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES
);

Installation

composer require json-api-php/json-api

Documentation

The library API and use-cases are expressed in comprehensive suite of tests.

• Data Documents (containing primary data)
  • With a single Resource Object
  • With a single Resource Identifier
  • With null data
  • With multiple Resource Objects
  • With multiple Resource Identifiers
• Compound Documents
• Error Documents
• Meta Documents (containing neither data nor errors)
• Pagination links
• JSON API Object
• Meta Object