cloudcreativity/laravel-json-api

JSON API (jsonapi.org) support for Laravel applications.

, _(*1)

cloudcreativity/laravel-json-api

Status

DO NOT USE THIS PACKAGE FOR NEW PROJECTS - USE laravel-json-api/laravel INSTEAD., _(*2)

This package has now been rewritten, substantially improved and released as the laravel-json-api/laravel package. Documentation for the new version is available on our new website laraveljsonapi.io and the code is now developed under the Laravel JSON:API Github organisation., _(*3)

The cloudcreativity/laravel-json-api package is now considered to be the legacy package. As we know it is in use in a lot of production applications, it will continue to receive bug fixes and updates for new Laravel versions. However, it is no longer supported for new features., _(*4)

If you are starting a new project, you MUST use the new package laravel-json-api/laravel., _(*5)

Introduction

Build feature-rich and standards-compliant APIs in Laravel., _(*6)

This package provides all the capabilities you need to add JSON API compliant APIs to your application. Extensive support for the specification, including:, _(*7)

• Fetching resources
• Fetching relationships
• Inclusion of related resources (compound documents)
• Sparse fieldsets.
• Sorting.
• Pagination.
• Filtering
• Creating resources.
• Updating resources.
• Updating relationships.
• Deleting resources.
• Validation of:
  • JSON API documents; and
  • Query parameters.

The following additional features are also supported:, _(*8)

• Full support for Eloquent resources, with features such as:
  • Automatic eager loading when including related resources.
  • Easy relationship end-points.
  • Soft-deleting and restoring Eloquent resources.
  • Page and cursor based pagination.
• Asynchronous processing.
• Support multiple media-types within your API.
• Generators for all the classes you need to add a resource to your API.

What is JSON API?

From jsonapi.org, _(*9)

If you've ever argued with your team about the way your JSON responses should be formatted, JSON API is your anti-bikeshedding weapon., _(*10)

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., _(*11)

For full information on the spec, plus examples, see http://jsonapi.org., _(*12)

Documentation

Full package documentation is available on Read the Docs., _(*13)

Slack

Join the Laravel JSON:API community on Slack., _(*14)

Laravel Versions

Make sure you consult the Upgrade Guide when upgrading between major or pre-release versions., _(*15)

License

Apache License (Version 2.0). Please see License File for more information., _(*16)

Installation

Installation is via composer. See the documentation for complete instructions., _(*17)

Contributing

Contributions are absolutely welcome. Ideally submit a pull request, even more ideally with unit tests. Please note the following:, _(*18)

• 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., _(*19)