JSON:API Resource

PHP 8.0 Library for parsing JSON:API resource in to data response.

Installation

composer require pz/jsonapi-resource

Documentation

• Library Documentation
• JSON:API Documentation

TODO

List of ideas and tasks must be implemented in the future.

• Feat: Resource meta PHP attribute
• Feat: Hydration or deserialization for resource creation or update.
• Docs: Metadata guide
• Docs: Full API Reference
• Research: Possible performance improvements.

Development

There are Dockerfile and docker-compose config needed for developing the library on same environment configurations. We suggest using docker-compose for the library development.

Docker-compose local configurations

Please copy docker-compose.override-example.yaml to docker-compose.override.yaml and set proper user UID and desired build type.

First we need to build the docker image.

docker-compose build app

Lets install composer dependencies from the container.

docker-compose run app composer install

Testing

We are using PestPHP for unit testing the code, so please read about before test.

docker-compose run app pest

For syntax verification and checks we use PHPSTan.

docker-compose run app phpstan

Contributing

Fill free to create issues and send merge requests.

Before sending merge request please run phpstan and pest.