PHPackages                             fxmonster/laravel-json-api - 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. fxmonster/laravel-json-api

ActiveLibrary[API Development](/categories/api)

fxmonster/laravel-json-api
==========================

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

v3.2.0(5y ago)06.8k1Apache-2.0PHPPHP ^7.3|^8.0

Since Oct 3Pushed 5y agoCompare

[ Source](https://github.com/fxmonster/laravel-json-api)[ Packagist](https://packagist.org/packages/fxmonster/laravel-json-api)[ Docs](https://github.com/cloudcreativity/laravel-json-api)[ RSS](/packages/fxmonster-laravel-json-api/feed)WikiDiscussions develop Synced today

READMEChangelogDependencies (18)Versions (78)Used By (0)

[![Build Status](https://camo.githubusercontent.com/ce315437db57c6f5e94fdf99c17b9f0bb5d4cce4fd25d63b93a245a716365ed4/68747470733a2f2f7472617669732d63692e6f72672f636c6f7564637265617469766974792f6c61726176656c2d6a736f6e2d6170692e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/cloudcreativity/laravel-json-api)

cloudcreativity/laravel-json-api
================================

[](#cloudcreativitylaravel-json-api)

Build feature-rich and standards-compliant APIs in Laravel.

This package provides all the capabilities you need to add [JSON API](http://jsonapi.org)compliant APIs to your application. Extensive support for the specification, including:

- 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:

- 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?

[](#what-is-json-api)

From [jsonapi.org](http://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 .

Tutorial and Documentation
--------------------------

[](#tutorial-and-documentation)

Want a tutorial to get started? Read the [*How to JSON:API* Laravel tutorial.](https://howtojsonapi.com/laravel.html)

Full package documentation is available on [Read the Docs](http://laravel-json-api.readthedocs.io/en/latest/).

Demo
----

[](#demo)

A demo application is available at [here](https://github.com/cloudcreativity/demo-laravel-json-api).

Laravel Versions
----------------

[](#laravel-versions)

LaravelThis Package`^8.0``^3.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](http://laravel-json-api.readthedocs.io/en/latest/upgrade/)when upgrading between major or pre-release versions.

Lumen
-----

[](#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](https://github.com/cloudcreativity/laravel-json-api/issues/61).

License
-------

[](#license)

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

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

[](#installation)

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

Contributing
------------

[](#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.

###  Health Score

39

↑

LowBetter than 87% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity19

Limited adoption so far

Community20

Small or concentrated contributor base

Maturity83

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 93.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~26 days

Recently: every ~19 days

Total

73

Last Release

1942d ago

Major Versions

0.x-dev → v1.0.0-beta.42018-10-11

v1.3.0 → v2.0.0-alpha.12019-08-09

v1.6.0 → v2.0.0-alpha.22020-01-13

1.x-dev → v2.0.0-beta.32020-04-13

v2.2.0 → v3.0.02020-09-09

PHP version history (6 changes)v0.1.0PHP &gt;=5.5.0

v0.6.0PHP ^5.6|^7.0

v1.0.0-beta.4PHP ^7.1

v2.0.0-beta.1PHP ^7.2

v3.0.0PHP ^7.3

v3.2.0PHP ^7.3|^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/bd798ef4478ec11bfe6a54f17cd0feca6380d901670e7c44121fb9f5381262b3?d=identicon)[fxmonster](/maintainers/fxmonster)

---

Top Contributors

[![lindyhopchris](https://avatars.githubusercontent.com/u/4464333?v=4)](https://github.com/lindyhopchris "lindyhopchris (790 commits)")[![jstoone](https://avatars.githubusercontent.com/u/1711456?v=4)](https://github.com/jstoone "jstoone (8 commits)")[![GIANTCRAB](https://avatars.githubusercontent.com/u/1075708?v=4)](https://github.com/GIANTCRAB "GIANTCRAB (8 commits)")[![pedroluislopez](https://avatars.githubusercontent.com/u/9784609?v=4)](https://github.com/pedroluislopez "pedroluislopez (4 commits)")[![jelhan](https://avatars.githubusercontent.com/u/4965703?v=4)](https://github.com/jelhan "jelhan (4 commits)")[![rekrios](https://avatars.githubusercontent.com/u/3911693?v=4)](https://github.com/rekrios "rekrios (3 commits)")[![fxmonster](https://avatars.githubusercontent.com/u/13942239?v=4)](https://github.com/fxmonster "fxmonster (3 commits)")[![zlodes](https://avatars.githubusercontent.com/u/1114387?v=4)](https://github.com/zlodes "zlodes (2 commits)")[![GregPeden](https://avatars.githubusercontent.com/u/1343049?v=4)](https://github.com/GregPeden "GregPeden (2 commits)")[![half2me](https://avatars.githubusercontent.com/u/6759894?v=4)](https://github.com/half2me "half2me (2 commits)")[![MCMatters](https://avatars.githubusercontent.com/u/3148853?v=4)](https://github.com/MCMatters "MCMatters (2 commits)")[![daryledesilva](https://avatars.githubusercontent.com/u/4393436?v=4)](https://github.com/daryledesilva "daryledesilva (2 commits)")[![mnrafg](https://avatars.githubusercontent.com/u/22196871?v=4)](https://github.com/mnrafg "mnrafg (2 commits)")[![minamassoud](https://avatars.githubusercontent.com/u/26849271?v=4)](https://github.com/minamassoud "minamassoud (1 commits)")[![moneal](https://avatars.githubusercontent.com/u/46388?v=4)](https://github.com/moneal "moneal (1 commits)")[![niels-numbers](https://avatars.githubusercontent.com/u/1765602?v=4)](https://github.com/niels-numbers "niels-numbers (1 commits)")[![simonj](https://avatars.githubusercontent.com/u/183790?v=4)](https://github.com/simonj "simonj (1 commits)")[![JeanLucEsser](https://avatars.githubusercontent.com/u/14908712?v=4)](https://github.com/JeanLucEsser "JeanLucEsser (1 commits)")[![askmrsinh](https://avatars.githubusercontent.com/u/6129517?v=4)](https://github.com/askmrsinh "askmrsinh (1 commits)")[![balaianu](https://avatars.githubusercontent.com/u/5259461?v=4)](https://github.com/balaianu "balaianu (1 commits)")

---

Tags

jsonapilaraveljsonapiJSON-APIjsonapi.orgcloudcreativity

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/fxmonster-laravel-json-api/health.svg)

```
[![Health](https://phpackages.com/badges/fxmonster-laravel-json-api/health.svg)](https://phpackages.com/packages/fxmonster-laravel-json-api)
```

###  Alternatives

[cloudcreativity/laravel-json-api

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

7911.0M4](/packages/cloudcreativity-laravel-json-api)[neomerx/json-api

Framework agnostic JSON API (jsonapi.org) implementation

7443.6M25](/packages/neomerx-json-api)[cloudcreativity/json-api-testing

PHPUnit test helpers to check JSON API documents.

141.6M3](/packages/cloudcreativity-json-api-testing)[laravel-json-api/core

Contracts and support classes for Laravel JSON:API packages.

101.5M8](/packages/laravel-json-api-core)[nilportugues/laravel5-json-api

Laravel 5 JSON API Transformer Package

31032.4k1](/packages/nilportugues-laravel5-json-api)[laravel-json-api/eloquent

Serialize Eloquent models as JSON:API resources.

121.3M3](/packages/laravel-json-api-eloquent)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
