Laravel-API-Exceptions

, _(*1)

All in one solution for exception for JSON REST APIs on Laravel and Lumen., _(*2)

About

The goal of this package is to provide you with a set of most common exceptions that may be needed while developing JSON REST API. It also:, _(*3)

Handles exceptions output.
Handles exceptions report to logs.
Overwrites default Validator to make validation errors more verbose.
Has a FormRequest that to handle validation errors and pass them to ApiExceptions layer.

Installation

PHP 5.4+ or HHVM 3.3+, Composer and Laravel 5.1+ are required., _(*4)

To get the latest version of Laravel Laravel-API-Debugger, simply add the following line to the require block of your composer.json file., _(*5)

For Laravel 5.1, _(*6)

"lanin/laravel-api-exceptions": "^0.1.0"

For Laravel 5.3, _(*7)

"lanin/laravel-api-exceptions": "^1.0.0"

You'll then need to run composer install or composer update to download it and have the autoloader updated., _(*8)

Once Laravel-API-Exceptions is installed, if you're using Laravel 5.1, 5.2, 5.3, and 5.4, you need to register the service provider. Open up config/app.php and add the following to the providers key., _(*9)

Lanin\Laravel\ApiExceptions\ApiExceptionsServiceProvider::class,

If you're using Laravel 5.5, you don't need to add anything in config/app.php. It will use package auto discovery feature in Laravel 5.5., _(*10)

Exceptions

Every ApiException can be thrown as a normal exception and they will be automatically serialized to JSON with corresponding HTTP status, if user wants json:, _(*11)

{
    "id": "not_found",
    "message": "Requested object not found."
}

This object will be also populated with trace info, when APP_DEBUG is true., _(*12)

Also it can have meta attribute when there is additional info. For example for validation errors:, _(*13)

{
    "id": "validation_failed",
    "message": "Validation failed.",
    "meta": {
        "errors": {
            "tags": [{
                "rule": "max.array",
                "message": "The tags may not have more than 10 items.",
                "parameters": ["10"]
            }]
        }
    }
}

For ValidationApiException, meta attribute has errors object that contains validations errors. Every attribute of this object is a name of a request parameter to validate to and value is an array of errors with description., _(*14)

Customization

You can customize errors APU response by overriding formatApiResponse method in your ExceptionsHandler., _(*15)

For example if you want to put everything under error attribute, you can do it like this:, _(*16)

/**
 * Format error message for API response.
 *
 * @param  ApiException  $exception
 * @return mixed
 */
protected function formatApiResponse(ApiException $exception)
{
    return [
        'error' => $exception->toArray(),
    ];
}

Handler

Extend your default exceptions handler with:, _(*17)

\Lanin\Laravel\ApiExceptions\LaravelExceptionHandler for Laravel
\Lanin\Laravel\ApiExceptions\LumenExceptionHandler for Lumen

And remove everything else. Example:, _(*18)

<?php

namespace App\Exceptions;

use Lanin\Laravel\ApiExceptions\LaravelExceptionHandler;

class Handler extends LaravelExceptionHandler
{

}

FormRequest

To use FormRequest extend all your Request classes with \Lanin\Laravel\ApiExceptions\Support\Request. It will automatically support validation errors and pass them to the output., _(*19)

It also has a very handy helper method validatedOnly() that returns from request only those items that are registered in rules method., _(*20)