nextdots/api-exceptions

JSON exceptions for your API

API Exceptions

Convert your Lumen exceptions into JSON:, _(*1)

{
  "code": nnn,
  "message": "a message",
  "description": "a description",
  "errors": [
    "error 1",
    "error 2",
    ...
  ]
}

Installation

Set your composer.json to allow less stable packages:, _(*2)

"minimum-stability" : "dev",  
"prefer-stable" : true

Require the package as usual:, _(*3)

composer require nextdots/api-exceptions

Change app/Exceptions/Handler.php:, _(*4)

• Change this:, _(*5)

  use Laravel\Lumen\Exceptions\Handler as ExceptionHandler;
  

• To this:, _(*6)

  use ApiExceptions\Handler as ExceptionHandler;
  

On Linux, you can do the same as above with the following command:, _(*7)

sed -i 's/Laravel\\Lumen\\Exceptions\\Handler/ApiExceptions\\Handler/' app/Exceptions/Handler.php

Example

use ApiExceptions\JsonResponseException;

$app->get('/throw-exception', function () {
    throw new JsonResponseException(400, "an exception", "a description");
});