sinema/json-api-error-laravel

Format generic JSON API errors for Laravel

0.4 2024-03-13 13:39 UTC

Requires

• php: ^8.2.0|^8.3.0
• laravel/framework: ^9.10|^10.0.2|^11.0
• sinema/json-api-error: ^0.7

MIT

• Sinema

• laravel
• json api
• Error Responses

README

Spec

https://jsonapi.org/examples/#error-objects-basics

Installation

composer require sinema/json-api-error-laravel

Usage

In your Laravel controller:

<?php

namespace App\Http\Controllers;

use Sinemah\JsonApi\Error\Error;
use Sinemah\JsonApi\Error\Responses\Laravel;
use Illuminate\Http\JsonResponse;

class AnyController extends Controller
{
    public function show(): JsonResponse
    {
        return Laravel::get()->json(
            Error::fromArray(
                [
                    'status' => 404,
                    'source' => null,
                    'title' => 'Item not found',
                    'detail' => sprintf('Item %s not found', request('item_uuid')),
                ]
            ),
            404
        );
    }
}

Response

{
    "errors": [
        {
            "status": 404,
            "title": "Item not found",
            "detail": "Item bd11f048-8663-4d95-8c7a-02a5579b0682 not found in customer data"
        }
    ]
}

Build an error stack.

<?php

namespace App\Http\Controllers;

use Sinemah\JsonApi\Error\Error;
use Sinemah\JsonApi\Error\Responses\Laravel;
use Illuminate\Http\JsonResponse;

class AnyController extends Controller
{
    public function show(): JsonResponse
    {
        return Laravel::get()
            ->add(Error::fromArray(['status' => 500, 'code' => 'first_error']))
            ->add(Error::fromArray(['status' => 500, 'code' => 'second_error']))
            ->add(Error::fromArray(['status' => 500, 'code' => 'third_error']))
            ->json();
    }
}

Response

{
    "errors": [
        {
            "status": 500,
            "code": "first_error"
        },
        {
            "status": 500,
            "code": "second_error"
        },
        {
            "status": 500,
            "code": "third_error"
        }
    ]
}

Laravel Response

You do not need to pass a status code via the json method. The status code will be fetched from the first error you pushed in the bag.

->json()

You can also overwrite the status code with the json method.

->json(null, 401)