dmavrin/laravel-api-exceptions

All in one solution for exception for JSON REST APIs on Laravel and Lumen.

Laravel-API-Exceptions

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

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:, _(*2)

• 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., _(*3)

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

For Laravel 5.1, _(*5)

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

For Laravel 5.3, _(*6)

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

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

Once Laravel-API-Exceptions is installed, you need to register the service provider. Open up config/app.php and add the following to the providers key., _(*8)

Lanin\Laravel\ApiExceptions\ApiExceptionsServiceProvider::class,

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:, _(*9)

{
    "error_id": "not_found",
    "error_message": "Requested object not found."
}

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

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

{
    "error_id": "validation_failed",
    "error_message": "Validation failed.",
    "error_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., _(*12)

Views

Since version 0.3.0 for Laravel 5.3 package can also return html view of the error, if Accept header not equals application/json., _(*13)

To change included views publish them via:, _(*14)

$ php artisan vendor:publish --tag=laravel-api-exceptions

Handler

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

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

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

<?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., _(*17)

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

Contributing

Please feel free to fork this package and contribute by submitting a pull request to enhance the functionalities., _(*19)