Laravel Api Debugger

Laravel API Debuuger is a minimal package to help you debug your JSON API.

How to install?

Take these steps to install Laravel API Debugger.

Step #1

Install the package using Composer.

composer require hesamrad/laravel-api-debugger

Step #2

Add the middleware to the routes you want to debug.

Route::get('users', function () {
    return response()->json([
        'users' => User::get()
    ]);
})->middleware('debugger'); // <- I added the middleware to a single route for testing.

For every request that goes through the specified middleware, you will have additional information to help with your debugging process.

Note

1- You need to set APP_DEBUG key to true inside your .env file in order to enable debugger.

2- Since this debugger works with JSON APIs, you will need to send Accept request header with the value of application/json.

Example

To demonstrate, I requested /users and provided the results shown below.

{
  "data": [
    {
      "id": 1,
      "name": "Demo User Number 1",
      "email": "[email protected]"
    },
    {
      "id": 2,
      "name": "Demo User Number 2",
      "email": "[email protected]"
    }
  ],
  "debugger": {
    "server": {
      "web_server": "nginx/1.27.5",
      "protocol": "HTTP/1.1",
      "remote_address": "192.168.73.1",
      "remote_port": "52697",
      "server_name": "test.local",
      "server_port": "80"
    },
    "app": {
      "environment": "local",
      "laravel_version": "12.18.0",
      "php_version": "8.3.22",
      "locale": "en"
    },
    "request": {
      "ip": "192.168.65.1",
      "uri": "/api",
      "method": "GET",
      "body": [],
      "headers": {
        "connection": [
          "keep-alive"
        ],
        "accept-encoding": [
          "gzip, deflate, br"
        ],
        "host": [
          "test.local"
        ],
        "cache-control": [
          "no-cache"
        ],
        "user-agent": [
          "PostmanRuntime/7.44.0"
        ],
        "accept": [
          "application/json"
        ]
      }
    },
    "session": {
      "authenticated": false,
      "token": null
    },
    "queries": {
      "count": 1,
      "data": [
        {
          "query": "select * from \"users\"",
          "bindings": [],
          "time": 1.17
        }
      ]
    }
  }
}

dd helper but for API!

This package introduces a handy helper called jdd used to dump date whenever needed. It's basically the same as dd method but only for APIs. (JDD stands for JSON Die and Dump.)

// api.php

$string = 'This is awesome!';

jdd($string);

It outputs this:

{
    "dump": [
        "This is awesome!"
    ],
    "trace": {
        "file": "/var/www/laravel-api-debugger/routes/api.php",
        "line": 14
    }
}

Disclaimer

This package can be dangerous when used on production environment; be sure to turn off APP_DEBUG on production to avoid leaking important information.