PHPackages                             cerbero/json-api-error - 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. cerbero/json-api-error

ActiveLibrary[API Development](/categories/api)

cerbero/json-api-error
======================

Laravel package to standardize API errors in compliance with the JSON:API spec.

0.5.0(1y ago)25.1k↓35%MITPHPPHP ^8.1CI passing

Since Mar 11Pushed 1y ago1 watchersCompare

[ Source](https://github.com/cerbero90/json-api-error)[ Packagist](https://packagist.org/packages/cerbero/json-api-error)[ Docs](https://github.com/cerbero90/json-api-error)[ GitHub Sponsors](https://github.com/cerbero90)[ Fund](https://ko-fi.com/cerbero90)[ RSS](/packages/cerbero-json-api-error/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (9)Versions (14)Used By (0)

💥 JSON:API Error
================

[](#-jsonapi-error)

[![Author](https://camo.githubusercontent.com/9de44458c0e2bc487bc12526bc79f35e5284bd28cc40ff000927641251e9dd50/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f617574686f722d6365726265726f39302d626c75653f6c6f676f3d78267374796c653d666c61742d737175617265266c6f676f53697a653d6175746f)](https://twitter.com/cerbero90)[![PHP Version](https://camo.githubusercontent.com/36ac61ac8d340c1b2ed26e3fb4c0fc90d09755f51cd569f2ddea957e1e35e4c2/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6365726265726f2f6a736f6e2d6170692d6572726f723f636f6c6f723d253233373637626235266c6f676f3d706870267374796c653d666c61742d737175617265266c6f676f53697a653d6175746f)](https://www.php.net)[![Laravel Version](https://camo.githubusercontent.com/17a998f41e6b7dfafeb0889e9f35ec7c45d03244a7f6e3577995c4ae82943d99/68747470733a2f2f696d672e736869656c64732e696f2f7374617469632f76313f6c6162656c3d6c61726176656c266d6573736167653d254532253839254135392e3026636f6c6f723d666632643230266c6f676f3d6c61726176656c267374796c653d666c61742d737175617265266c6f676f53697a653d6175746f)](https://laravel.com)[![Build Status](https://camo.githubusercontent.com/3fad1a1c8d00b3e01068c4b2a7a611a4af6a87ee4e55937349fff229fa5bf1b3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f6365726265726f39302f6a736f6e2d6170692d6572726f722f6275696c642e796d6c3f6272616e63683d6d6173746572267374796c653d666c61742d737175617265266c6f676f3d676974687562266c6f676f53697a653d6175746f)](https://github.com/cerbero90/json-api-error/actions?query=workflow%3Abuild)[![Coverage Status](https://camo.githubusercontent.com/463ef694fb025cd7e6df2ea7a3671a31bfbdd927b2290ddbd679e7e2f6ec93ac/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f636f7665726167652f672f6365726265726f39302f6a736f6e2d6170692d6572726f722e7376673f7374796c653d666c61742d737175617265266c6f676f3d7363727574696e697a6572266c6f676f53697a653d6175746f)](https://scrutinizer-ci.com/g/cerbero90/json-api-error/code-structure)[![Quality Score](https://camo.githubusercontent.com/f35eb4e887a06a202301bd8527de7b4432c1fa17d3d05dc11b4a18745fec67c8/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f6365726265726f39302f6a736f6e2d6170692d6572726f722e7376673f7374796c653d666c61742d737175617265266c6f676f3d7363727574696e697a6572266c6f676f53697a653d6175746f)](https://scrutinizer-ci.com/g/cerbero90/json-api-error)[![PHPStan Level](https://camo.githubusercontent.com/021d34200bcded1d7fc6a07ff5a54da8ef9c6aa843c80a91f3bf2020574cb11d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6576656c2d6d61782d737563636573733f7374796c653d666c61742d737175617265266c6f676f3d646174613a696d6167652f706e673b6261736536342c6956424f5277304b47676f414141414e53556845556741414143414141414167434159414141427a656e72304141414762306c455156523432753158653142555a52532f79344b67386f6952334643434255795345535a4252436961426e6d45734f7a65537a73672b4b7859594f3964454566744e52715a6a78343046525a6b5470716d4f7a3553324c73586c455a42636961746b516e484447596147644679314570474d486c2f702f5064466c7432726b354f2b4a396e356e412f767466356e6564336c6e6c49537052686166426c4c524c4843744a475672422f5a4244736177326c55717a526547414334364473745459666e534347556a61614476677841436f366a337655656e4e64496d65525871646e575635617a3572726e7a655a7a6e6a384a2b4535467473636c68663373344a3443532f6f52783542766f6e385a553635464759517841776366383561374365527a2b4334315448656a75657964435a3741414b33346e7776336b48502f6f554b644f4c344b373235386646374375643432374f3438525165476b49474a37374e38665a716c726366525034642f78393057516648584c65427439645472536c776c33563635796e574c4d315345413271624e51636b626534586d77773130486d79337368696430434d636d6c454a745344736c35565a42646641674d7649337575522b6d6f4a714e364c61786d70734f42654c43446d546966434239325263516d6241554a767471414c63357351723870383667594243634664427139774f696e374e5161783665776c423672714c5a486632334650313079336c6a36754a74454267324878695643747a64335345774d4243696f364e6839757a5a344f2f764c774f5a344f554e4d324e79494750467276757a42472f2f6c5250732b5651326b316b692b65506b64383462736b7a375946705967697a457a3838503876507a596666753364445330674a4e545531515856304e71616d70524b31574977676669453471684f7969673072432b7043764b3851556f4d4c37754a564841356b635155703344537071576a6333642f4479386f4b696f694c6f367571436f614568754862314b765430394141684246706257346c4f70794d797949425153436d6f55514c517a676e694e767a2b6f624232485332527742674536644f7843794a6f676d4e6b503275315772687734514a30332b69477252395845643343544e426e366543626f3430775044774d645856314246314456473571694574626f78535550364a37312b44334e775541684c4f4952517a6d376c6e6e68595576375146762f79445a2f4c6d3575624b3244564939695a386252384a4474454235376c4e7a454e514e364f6a6f49476c70616249565a7359614d544f2b6872696b525241314a786d5358396845372f734a745679463338744b735543565a7842687a396a49337747542f514a6c41447a50417958726e6a306b496e7a47485143524d794f672f65643275486a784975453454675951487132444c4a71756d617368592b6c6e734d433447564335646f365856754b396c2b34536b4e38792b47665965564a6e32672b2b553751796750543064426759474944765435386d6e46355051636a433833507a5346396648375331745a47456841515a514f54384a61413331376f496b4d366a533875564c53447a4f517167323355682b4d6c6b4f66303047673063503334632b7676373455527a4d396e34316762792f7276766b63374f54686c415455334e4347594a5558743451614c75545977426354534f426d6a315244374434547369783442794f6a5a52462f7a677570444562675a336a346c792f71656b704e44306f35615134344853344f416773567174493167545a4f303149624730615031626b6e6e7843445576417248692b42306c4a536c7a676c5446594f3275644633516c39544372486e356f45497265487036516c5255464a53556c4a43717169705357566c4a38764c79434759494653374853337a476138376d76346c636a4c774c6c53746c4c544b59595555416c76726c444763573435774b785858366171485a4e75744d2b316f51424846546577414b6b6f48342b7671436a3438505941475335796235616d6a4e6f4f2b435532534c35334e4b70444430767848486d4f4a6972374c357855765a676d307573325231343253634f4979567159766c70575534586f4849503844584c32622b776a6457655868365532466a6d49494b6d625741595046524d75733632682f676549766a4f51596c707544797351724c4c364765723439486757386a7176585568493755764462396961535444714874794974694635537577356577462f4e6438564a367a6c68736e30366245687758344e79664376754745655270546d68346d6b47363879447079757a42394555636a553561776241676e63506c4165536441514552307a436e647a715662655843347144734d70764745594258526e734478344e33417566314643546a5449615674592f51546d643049386242566d316b656a45756255664f30317671496d6e336334395837717065714939696e4967746270784b3359724b66494a43742b4f6556326e665556465234636134456b56454e794137676b59634d66423152354d4d6d785a37657a2f324b463553534e3179562b3135385550734a54305a4263493262524c744958476f5975354665724f55694a65314f66734c335845574834336c324b532b694a46392b53344670634e6773632b6a3863543848346f31626650672f716b4c743530754a31527a644d7347673055717766454e313134507762314374575447672b59395535436c4b397837785557493742493556515670304156635133625a6b51686d6e45676448684b794e535a65313663727442496c63377349623663524c6674325043676f4b476a696a4244746a72415137613345644d73787a4952666c414649685062366d48596d5977582b57426c505167736b6867567279794a4351794e79424c73425164513666677351687974364d534f4f73575a37676248387745546d67524b41696a61744e4c384e676d30787834744c6373707330577a7834616c306a586c493430422f413370613134344d447453674141414141456c46546b5375516d4343266c6f676f53697a653d6175746f)](https://phpstan.org/)[![Total Downloads](https://camo.githubusercontent.com/cdcc7ce414f00f27797603a761620c9047af3017e57a6dcebf17a84680708f68/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6365726265726f2f6a736f6e2d6170692d6572726f722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/cerbero/json-api-error)[![Latest Version](https://camo.githubusercontent.com/8d0570ceaead1423ea8d1391054bdc0dbd67c38a7ac71f8393bc9fe4f902a018/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6365726265726f2f6a736f6e2d6170692d6572726f722e7376673f6c6162656c3d76657273696f6e267374796c653d666c61742d737175617265)](https://packagist.org/packages/cerbero/json-api-error)[![Software License](https://camo.githubusercontent.com/942e017bf0672002dd32a857c95d66f28c5900ab541838c6c664442516309c8a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![PER](https://camo.githubusercontent.com/84278b6753117019e91c00fda1fe3c0b04f80f38e435f191ddef6fe2069e2607/68747470733a2f2f696d672e736869656c64732e696f2f7374617469632f76313f6c6162656c3d636f6d706c69616e6365266d6573736167653d50455226636f6c6f723d626c7565267374796c653d666c61742d737175617265)](https://www.php-fig.org/per/coding-style/)

```
{
  "errors": [
    {
      "status": "422",
      "title": "Unprocessable Content",
      "detail": "The name field must be a string.",
      "source": {
        "pointer": "/name"
      }
    },
    {
      "status": "422",
      "title": "Unprocessable Content",
      "detail": "The name field must be at least 2 characters.",
      "source": {
        "pointer": "/name"
      }
    }
  ]
}
```

Laravel package to standardize API error responses in compliance with the [JSON:API spec](https://jsonapi.org/examples/#error-objects), providing:

- **consistency**: ensure uniform API error responses across all Laravel apps, adhering to a widely used standard
- **automation**: handle Laravel-specific and common HTTP exceptions automatically
- **simplicity**: focus solely on error responses without the need to implement the full JSON:API spec
- **zero configuration**: install the package with no additional configuration required
- **customization**: optionally register custom handlers, map errors to HTTP statuses or merge default data
- **localization**: translate JSON:API errors into any language
- **testability**: test error responses using the built-in testing tools
- **debugging**: inspect the original message and trace when an unexpected error occurs

📦 Install
---------

[](#-install)

Via Composer:

```
composer require cerbero/json-api-error
```

🔮 Usage
-------

[](#-usage)

Note

Work in progress... 🏗️

- implement `links`
- write documentation
- reach 100% code coverage
- tag stable version

📆 Change log
------------

[](#-change-log)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

🧪 Testing
---------

[](#-testing)

```
composer test
```

💞 Contributing
--------------

[](#-contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE\_OF\_CONDUCT](CODE_OF_CONDUCT.md) for details.

🧯 Security
----------

[](#-security)

If you discover any security related issues, please email  instead of using the issue tracker.

🏅 Credits
---------

[](#-credits)

- [Andrea Marco Sartori](https://twitter.com/cerbero90)
- [All Contributors](../../contributors)

⚖️ License
----------

[](#️-license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance42

Moderate activity, may be stable

Popularity25

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~29 days

Recently: every ~61 days

Total

12

Last Release

475d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/596523?v=4)[Matteo Picciolini](/maintainers/cerbero)[@cerbero](https://github.com/cerbero)

---

Top Contributors

[![cerbero90](https://avatars.githubusercontent.com/u/5838106?v=4)](https://github.com/cerbero90 "cerbero90 (10 commits)")

---

Tags

apierror-handlingjsonjson-apilaraveljsonapilaravelerrorsJSON-APIerror handling

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/cerbero-json-api-error/health.svg)

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

###  Alternatives

[cloudcreativity/laravel-json-api

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

7881.1M5](/packages/cloudcreativity-laravel-json-api)[essa/api-tool-kit

set of tools to build an api with laravel

52680.5k](/packages/essa-api-tool-kit)[dragon-code/laravel-json-response

Automatically always return a response in JSON format

1118.6k1](/packages/dragon-code-laravel-json-response)[wayofdev/laravel-symfony-serializer

📦 Laravel wrapper around Symfony Serializer.

2113.6k](/packages/wayofdev-laravel-symfony-serializer)

PHPackages © 2026

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