What is JSON API?
If you've ever argued with your team about the way your JSON responses should be formatted, JSON API is your anti-bikeshedding weapon.
By following shared conventions, you can increase productivity, take advantage of generalized tooling, and focus on what matters: your application. Clients built around JSON API are able to take advantage of its features around efficiently caching responses, sometimes eliminating network requests entirely.
For full information on the spec, plus examples, see http://jsonapi.org.
A demo application is available at here.
Make sure you consult the Upgrade Guide when upgrading.
Currently we have not integrated the package with Lumen. We do not have any active projects that use Lumen, so if you do and can help, please let us know on this issue.
Documentation is available on Read the Docs.
We are aiming for
v1.0.0 as soon as possible. Now we are on
1.0.0-beta.* releases there will be a minimal
amount of breaking changes to fixing the few remaining issues.
Check the progress here.
We have production applications that are using the package and extensive test coverage of this package and those applications.
Apache License (Version 2.0). Please see License File for more information.
Installation is via
composer. See the documentation for complete instructions.
Contributions are absolutely welcome. Ideally submit a pull request, even more ideally with unit tests. Please note the following:
- Bug Fixes - submit a pull request against the
- Enhancements / New Features - submit a pull request against the
We recommend submitting an issue before taking the time to put together a pull request.