JSON API (jsonapi.org) package for Laravel applications.
Latest commit 93c102b Oct 13, 2018

README.md

Build Status

cloudcreativity/laravel-json-api

Add jsonapi.org compliant APIs to your Laravel 5 application. Based on the framework agnostic package neomerx/json-api.

What is JSON API?

From jsonapi.org

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.

Demo

A demo application is available at here.

Laravel Versions

Laravel This Package EOL?
5.7.* 1.0.0-beta.5 -
5.6.* 1.0.0-beta.5 -
5.5.* 1.0.0-beta.5 -
5.4.* 1.0.0-beta.3 EOL

Make sure you consult the Upgrade Guide when upgrading.

Lumen

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

Documentation is available on Read the Docs.

Status

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.

License

Apache License (Version 2.0). Please see License File for more information.

Installation

Installation is via composer. See the documentation for complete instructions.

Contributing

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 master branch.
  • Enhancements / New Features - submit a pull request against the develop branch.

We recommend submitting an issue before taking the time to put together a pull request.