PHPackages                             czim/laravel-jsonapi - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. czim/laravel-jsonapi

AbandonedArchivedLibrary[API Development](/categories/api)

czim/laravel-jsonapi
====================

Laravel JSON-API Base.

1.5.4(6y ago)1664.4k↓50%1[3 issues](https://github.com/czim/laravel-jsonapi/issues)MITPHPPHP >=7.1.3

Since Dec 15Pushed 6y ago2 watchersCompare

[ Source](https://github.com/czim/laravel-jsonapi)[ Packagist](https://packagist.org/packages/czim/laravel-jsonapi)[ Docs](https://github.com/czim)[ RSS](/packages/czim-laravel-jsonapi/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (9)Versions (48)Used By (0)

[![Latest Version on Packagist](https://camo.githubusercontent.com/b0a4c91742c9eb0f6b99e0a1997fcdb829bfc434bb778fdb22675ba863ea1078/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f637a696d2f6c61726176656c2d6a736f6e6170692e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/czim/laravel-jsonapi)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Build Status](https://camo.githubusercontent.com/2d1b1f79a763c0e999d50e6b88e0dfe17a5eb3549f3ffac63559a27251e650ec/68747470733a2f2f7472617669732d63692e6f72672f637a696d2f6c61726176656c2d6a736f6e6170692e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/czim/laravel-jsonapi)[![Coverage Status](https://camo.githubusercontent.com/b1e8403a1e91215afbdfc53454d4f3b8856456ee471f4950e3a3d1234bc43f5b/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f637a696d2f6c61726176656c2d6a736f6e6170692f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/czim/laravel-jsonapi?branch=master)

JSON-API Base
=============

[](#json-api-base)

Basic application elements for JSON-API projects.

Offers means for quickly scaffolding JSON-API compliance for Laravel applications.

This does *NOT* provide the means to set up the API or the means for user authorisation.

Disclaimer
----------

[](#disclaimer)

This is very much a work in progress at this time. Interface- and other breaking changes may happen.
The old, discontinued version of this project is in the `0.9.5` branch.

Version Compatibility
---------------------

[](#version-compatibility)

LaravelPackage5.31.35.4 to 5.61.45.7 to 6.01.5Note that version 1.5+ requires PHP 7.1.3+ and czim/laravel-dataobject 2.0+.

Changelog
---------

[](#changelog)

[View the changelog](CHANGELOG.md).

Installation
------------

[](#installation)

Via Composer

```
$ composer require czim/laravel-jsonapi
```

Add the `JsonApiServiceProvider` to your `config/app.php`:

```
Czim\JsonApi\Providers\JsonApiServiceProvider::class,
```

Publish the configuration file.

```
php artisan vendor:publish
```

### Exceptions

[](#exceptions)

In your `App\Exceptions\Handler`, change the `render()` method like so:

```