Download the PHP package art4/json-api-client without Composer
On this page you can find all versions of the php package art4/json-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package json-api-client
JsonApiClient
JsonApiClient :construction_worker_woman: is a PHP Library to validate and handle the response body from a JSON API Server.
Format: JSON API 1.0
:checkered_flag: Goals
- ✅ Be 100% JSON API 1.0 spec conform
- ⬜ Be open for new spec minor versions (see #90)
- ✅ Handle/validate a server response body
- ✅ Handle/validate a client request body
- ✅ Offer an easy way to retrieve the data
- ✅ Allow extendability and injection of classes/models
:package: Install
Via Composer
:building_construction: Upgrade to v1
Version 1.0 is finally released. :tada:
After version 0.8.0 there where no breaking changes. Every change was backward compatible and every functionality that was removed in v1.0 only triggers a deprecation warning in v0.10.
To upgrade from v0.x to v1 just update to 0.10.2 and resolve all deprecation warnings.
Or in 3 simple steps:
- Update your composer.json to
"art4/json-api-client": "^0.10.2"
- Make your code deprecation warnings free
- Upgrade your composer.json to
"art4/json-api-client": "^1.0"
without breaking your app
(Compare the Symfony upgrade documentation)
:rocket: Usage
See the documentation.
Using as parser
Note: Using Art4\JsonApiClient\Helper\Parser
is just a shortcut for directly using the Manager.
$document
implements the Art4\JsonApiClient\Accessable
interface to access the parsed data. It has the methods has($key)
, get($key)
and getKeys()
.
Using as validator
JsonApiClient can be used as a validator for JSON API contents:
Extend the client
Need more functionality? Want to directly inject your model? Easily extend JsonApiClient with the Factory.
:loud_sound: Changelog
Please see CHANGELOG for more information what has changed recently.
:wrench: Contributing
Please feel free to fork and sending Pull Requests. This project follows Semantic Versioning 2 and PER-CS2.0.
This projects comes with a docker-compose.yml
where all tools for development are available.
Run docker compose build
to build the image. Once you've build it, run docker compose up -d
to start the container in the background.
Run docker compose exec -u 1000 php bash
to use the bash inside the running container. There you can use all tools, e.g. composer with composer --version
Use exit
to logout from the container and docker compose stop
to stop the running container.
All following commands can be run inside the running docker container.
:white_check_mark: Testing
Run PHPUnit for all tests:
Run PHPStan for static code analysis:
Let PHPUnit generate a HTLM code coverage report:
You can find the code coverage report in .phpunit.cache/code-coverage/index.html
.
:white_check_mark: REUSE
The REUSE Helper tool makes licensing easy for humans and machines alike. It downloads the full license texts, adds copyright and license information to file headers, and contains a linter to identify problems.
Check all files for REUSE spec compliance:
Run this command to annotate PHP files in src and tests folders:
:heart: Credits
- Artur Weigandt
- All Contributors
:page_facing_up: License
GPL3. Please see License File for more information.