Laravel Json Exception Handler

Adds methods to your App\Exceptions\Handler to treat json responses. It is most useful if you are building APIs!

Requirements

• Laravel Framework >= 5.4
• php >= 7.0

JsonAPI

Using JsonAPI standard to responses!

Features

Default error response:

{
"errors": [
{
"status": "404",
"code": "13",
"title": "model_not_found_exception",
"detail": "User not found",
"source": {
"pointer": "data/id"
}
}
]
}

To Illuminate\Validation\ValidationException:

{
"errors": [
{
"status": "422",
"code": "1411",
"title": "Required validation failed on field name",
"detail": "The name field is required.",
"source": {
"pointer": "name"
}
},
{
"status": "422",
"code": "1421",
"title": "Email validation failed on field email",
"detail": "The email must be a valid email address.",
"source": {
"pointer": "email"
}
}
]
}

Treated Exceptions

• Illuminate\Auth\Access\AuthorizationException
• Illuminate\Auth\AuthenticationException
• Illuminate\Database\Eloquent\ModelNotFoundException
• Illuminate\Validation\ValidationException
• Laravel\Passport\Exceptions\MissingScopeException
• League\OAuth2\Server\Exception\OAuthServerException
• Symfony\Component\HttpKernel\Exception\NotFoundHttpException
• Symfony\Component\HttpKernel\Exception\BadRequestHttpException

Installing and configuring

Install the package

$ composer require sfelix-martins/json-exception-handler

If you are not using Laravel 5.5 version add the JsonHandlerServiceProvider to your config/app.php providers array:

'providers' => [
...
SMartins\Exceptions\JsonHandlerServiceProvider::class,
],

Publish the config to set your own exception codes

$ php artisan vendor:publish --provider="SMartins\JsonHandler\JsonHandlerServiceProvider"

Set your exception codes on config/json-exception-handler.php on codes array.

You can add more fields and codes to validation_fields array.

You can add too your models on lang packages to return the Not Found response translated correctly.

In resources/lang/vendor/exception/lang/$locale in exceptions file you can set on models array. Example:

'models' => [
'User' => 'Usuário',
'Article' => 'Artigo',
]

Using

Use the trait on your App\Exception\Handler and add method jsonResponse() passing the $exception if $request expects a json response on render()method

useSMartins\Exceptions\JsonHandler;
class Handler extends ExceptionHandler
{
use JsonHandler;
// ...publicfunctionrender($request, Exception$exception)
{ if ($request->expectsJson()) {
return$this->jsonResponse($exception);
}
returnparent::render($request, $exception);
}
// ...

Use sample

class UserController extends Controller
{
// ...publicfunctionstore(Request$request)
{
// Validation$request->validate($this->rules);
// or$this->validate($request, $this->rules);
//and or
Validator::make($request->all(), $this->rules)->validate();
if (condition()) {
// Generate response with http code and messageabort(403, 'Action forbidden!');
}
if (anotherCondition()) {
// Generate response with message and codethrownewTokenMismatchException("Error Processing Request", 10);
}
}
publicfunctionshow($id)
{
// If not found the default response is called$user = User::findOrFail($id);
// Gate define on AuthServiceProvider// Generate an AuthorizationException if fail$this->authorize('users.view', $user->id);
}

Extending

You can too create your own handler to any Exception. E.g.:

• Create a Handler class that extends of AbstractHandler:

namespaceApp\Exceptions;
useGuzzleHttp\Exception\ClientException;
useSMartins\Exceptions\Handlers\AbstractHandler;
class GuzzleClientHandler extends AbstractHandler
{
/** * Create instance using the Exception to be handled. * * @param \GuzzleHttp\Exception\ClientException $e */publicfunction__construct(ClientException$e)
{
parent::__construct($e);
}
}

• You must implements the method handle() from AbstractHandler class. The method must return an instance of Error or ErrorCollection:

namespaceApp\Exceptions;
useSMartins\Exceptions\JsonAPI\Error;
useSMartins\Exceptions\JsonAPI\Source;
useGuzzleHttp\Exception\ClientException;
useSMartins\Exceptions\Handlers\AbstractHandler;
class GuzzleClientHandler extends AbstractHandler
{
// ...publicfunctionhandle()
{
return (newError)->setStatus($this->getStatusCode())
->setCode($this->getCode())
->setSource((newSource())->setPointer($this->getDefaultPointer()))
->setTitle($this->getDefaultTitle())
->setDetail($this->exception->getMessage());
}
publicfunctiongetCode()
{
// You can add a new type of code on `config/json-exception-handlers.php`returnconfig('json-exception-handler.codes.client.default');
}
}

namespaceApp\Exceptions;
useSMartins\Exceptions\JsonAPI\Error;
useSMartins\Exceptions\JsonAPI\Source;
useSMartins\Exceptions\JsonAPI\ErrorCollection;
useSMartins\Exceptions\Handlers\AbstractHandler;
class MyCustomizedHandler extends AbstractHandler
{
publicfunction__construct(MyCustomizedException$e)
{
parent::__construct($e);
}
publicfunctionhandle()
{
$errors = (newErrorCollection)->setStatusCode(400);
$exceptions = $this->exception->getExceptions();
foreach ($exceptionsas$exception) {
$error = (newError)->setStatus(422)
->setSource((newSource())->setPointer($this->getDefaultPointer()))
->setTitle($this->getDefaultTitle())
->setDetail($exception->getMessage());
$errors->push($error);
}
return$errors;
}
}

• Now just registry your customized handler on App\Exception\Handler file on attribute exceptionHandlers. E.g:

namespaceApp\Exceptions;
useException;
useGuzzleHttp\Exception\ClientException;
useIlluminate\Foundation\Exceptions\HandlerasExceptionHandler;
useSMartins\Exceptions\JsonHandler;
class Handler extends ExceptionHandler
{
use JsonHandler;
protected$exceptionHandlers = [
// Set on key the exception and on value the handler.
ClientException::class => GuzzleClientHandler::class,
];

Response References:

• http://jsonapi.org/format/#errors