dorgaren / laravel-json-api
Legacy (0.x) JSON API (jsonapi.org) support for Laravel applications
Requires
- php: ^5.6|^7.0
- ext-json: *
- cloudcreativity/json-api: ^0.11
- illuminate/console: ^5.5|^6.0
- illuminate/contracts: ^5.4|^6.0
- illuminate/database: ^5.4|^6.0
- illuminate/filesystem: ^5.4|^6.0
- illuminate/http: ^5.4|^6.0
- illuminate/pagination: ^5.4|^6.0
- illuminate/support: ^5.4|^6.0
- symfony/psr-http-message-bridge: ^1.0
- zendframework/zend-diactoros: ^1.3
Requires (Dev)
- ext-sqlite3: *
- cloudcreativity/json-api-testing: ^0.3|^0.4|^1.0
- mockery/mockery: ^1.1
- orchestra/testbench: ^3.4|^4.0
- phpunit/phpunit: ^5.7|^6.0|^7.0|^8.0
Suggests
- cloudcreativity/json-api-testing: Required to use the test helpers.
This package is not auto-updated.
Last update: 2024-04-16 12:12:36 UTC
README
This package is a fork of cloudcreativity/laravel-json-api. It is created to maintain backwards compatibility with 0.x versions.
Reasons:
- there is no upgrade guide nor changelog from 0.x to 1.x;
- the architecture has been changed radically, even to the point where classes become final;
- there is no clear (nor unclear) reasoning behind architectural decisions;
- 0.13 being the last 0.x version released; and
- 0.13 being incompatible with Laravel 5.8+.
Since currently I have to maintain at least one project that has been created when the last version was 0.12.0, extending classes that have become final, and also the package's architecture posing serious questions towards possible use cases having been had considered, I figured it is easier to revamp the original branch than upgrading any projects just yet.
If you face similar problems, feel free to use this fork. I can, while being around, guarantee that I will bump versions and even make minor modifications necessary to keep this compatible with new Laravel versions, and also that I will respond when I deem anything further infeasible or unlikely.
For any new, fresh "greenfield" projects, though, it is advisable that you use the mainline package, either 1.x or 2.0 when it will become final.
Add jsonapi.org compliant APIs to your Laravel 5 application. Based on the framework agnostic packages neomerx/json-api and cloudcreativity/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 |
|---|---|
| 5.4.* | ^0.13 |
| 5.5.* | ^0.13 |
| 5.6.* | ^0.13 |
| 5.7.* | ^0.13 |
Make sure you consult the Upgrade Guide when upgrading.
Lumen
Currently we have not integrated the package with Lumen. If you use Lumen and can help, please let us know on this issue.
Documentation
Documentation is available on Read the Docs.
Status
This repository is under development. We have production applications that are using the package and extensive test coverage of these applications.
We are aiming for v1.0 as soon as possible. See this issue for progress.
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
masterbranch. - Enhancements / New Features - submit a pull request against the
developbranch.
We recommend submitting an issue before taking the time to put together a pull request.