2017 © Pedro Peláez
 

library laravel-json-api

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

image

cloudcreativity/laravel-json-api

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

  • Friday, July 13, 2018
  • by lindyhopchris
  • Repository
  • 17 Watchers
  • 166 Stars
  • 27,424 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 41 Forks
  • 42 Open issues
  • 51 Versions
  • 16 % Grown

The README.md

Tests, (*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

Laravel This Package
^9.0 ^4.0
^8.0 ^3.0|^4.0
^7.0 ^2.0
^6.0 ^1.7
5.8.* ^1.7
5.7.* ^1.0
5.6.* ^1.0
5.5.* ^1.0

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)

The Versions

25/03 2017

dev-feature/issue53

dev-feature/issue53 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

16/03 2017

v0.7.0

0.7.0.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

23/02 2017

v0.6.2

0.6.2.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

22/02 2017

v0.6.1

0.6.1.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

20/02 2017

v0.6.0

0.6.0.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

21/12 2016

v0.5.4

0.5.4.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

01/12 2016

v0.5.3

0.5.3.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

11/11 2016

v0.5.2

0.5.2.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

09/11 2016

v0.5.1

0.5.1.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

21/10 2016

v0.5.0

0.5.0.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

01/09 2016

v0.4.6

0.4.6.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

26/08 2016

v0.4.5

0.4.5.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

26/08 2016

v0.4.4

0.4.4.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

16/08 2016

v0.4.3

0.4.3.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

11/08 2016

v0.4.2

0.4.2.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

27/07 2016

v0.4.1

0.4.1.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

20/07 2016

v0.4.0

0.4.0.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

19/03 2016

dev-feature/pagination

dev-feature/pagination https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

28/01 2016

v0.3.0

0.3.0.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

23/10 2015

v0.2.1

0.2.1.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

17/10 2015

v0.2.0

0.2.0.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

11/10 2015

v0.1.1

0.1.1.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity

03/10 2015

v0.1.0

0.1.0.0 https://github.com/cloudcreativity/laravel-json-api

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

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

by Cloud Creativity Ltd

laravel api json jsonapi json-api jsonapi.org cloudcreativity