Easily debug your JSON API.

4.2.0 2019-02-02 13:21 UTC

This package is auto-updated.

Last update: 2020-08-30 01:37:49 UTC



Easily debug your JSON API.

This Package is an enhancement of Laravel-API-Debugger Package to add compatibility for Lumen framework

When you are developing JSON API sometimes you need to debug it, but if you will use dd() or var_dump() you will break the output that will affect every client that is working with your API at the moment. Debugger is made to provide you with all your debug information and not corrupt the output.

  "posts": [
      "id": 1,
      "title": "Title 1",
      "body": "Body 1"
      "id": 2,
      "title": "Title 2",
      "body": "Body 2"
  "meta": {
    "total": 2
  "debug": {
    "database": {
      "total": 2,
      "time": 2.72,
      "items": [
          "connection": "accounts",
          "query": "select * from `users` where `email` = '' limit 1;",
          "time": 0.38
          "connection": "posts",
          "query": "select * from `posts` where `author` = '1';",
          "time": 1.34
          "connection": "posts",
          "query": "select * from `posts` where `author` = '1';",
          "time": 1
      "duplicated": [
          "connection": "posts",
          "query": "select * from `posts` where `author` = '1';",
          "total_time": 2.34,
          "executions_count": 2
    "dump": [


This help is for Laravel 5.4 only. Readme for earlier versions can be found in the relevant branches of this repo.

PHP >=5.5.9+ or HHVM 3.3+, Composer and Laravel 5.4+ are required.


composer require saad/api-debugger

For Lumen

1- Register the package service provider

// bootstrap/app.php

2- this package will be enabled/disabled according to api-debugger.enabled configuration which depends on this env value ENABLE_API_DEBUG

you can copy the configuration file api-debugger.php to config directory and customize it as you like by doing this, you will have to register the new configuration file in bootstrap/app.php

// bootstrap/app.php

For Laravel 5.4

Open up config/app.php and add the following to the providers key.


Also you can register a Facade for easier access to the Debugger methods.

'Debugger' => Lanin\Laravel\ApiDebugger\Facade::class,

For Laravel 5.5

package supports package discovery feature.

Json response

Before extension will populate your answer it will try to distinguish if it is a json response. It will do it by validating if it is a JsonResponse instance. The best way to do it is to return response()->json(); in your controller's method.

Also please be careful with what you return. As if your answer will not be wrapped in any kind of data attribute (pages in the example above), frontend could be damaged because of waiting the particular set of attributes but it will return extra debug one.

So the best way to return your responses is like this

$data = [
    'foo' => 'bar',
    'baz' => 1,

return response()->json([
    'data' => [
        'foo' => 'bar',
        'baz' => 1,

For more info about better practices in JSON APIs you can find here


Debugger's two main tasks are to dump variables and collect anny additional info about your request.

Var dump

Debugger provides you with the easy way to dump any variable you want right in your JSON answer. This functionality sometimes very handy when you have to urgently debug your production environment.

$foo = 'foo';
$bar = [1, 2, 'bar'];

// As a helper
lad($foo, $bar);

// or as a facade
\Debugger::dump($foo, $bar);

You can simultaneously dump as many vars as you want and they will appear in the answer.

Note! Of course it it not the best way do debug your production environment, but sometimes it is the only way. So be careful with this, because everyone will see your output, but at least debug will not break your clients.

Collecting data

Note! By default Debugger will collect data ONLY when you set APP_DEBUG=true. So you don't have to worry that someone will see your system data on production.

All available collections can be found in api-debugger.php config that you can publish and update as you wish.


This collections listens to all queries events and logs them in connections, query, time structure.


It can show you cache hits, misses, writes and forgets.


It allows you to measure time taken to perform actions in your code. There are 2 ways to do it.


Debugger::profileMe('event-name', function () {

Or manually:


Also helpers are available:



You can easily add your own data collections to debug output. Just look at how it was done in the package itself and repeat for anything you want (for example HTTP requests).


Please feel free to fork this package and contribute by submitting a pull request to enhance the functionalities.