README

Laravel Api Debugger

Laravel-Api-Debuuger is a minimal package to help you debug your json apis.

It's very easy to setup; let me show you.

How to install?

Take these steps to install Laravel API Debugger.

Step #1

Install the package from Composer.

composer require hesamrad/laravel-api-debugger

Step #2

Add it to the routes you want to debug.

Route::middleware('debugger')->group(function () { // <- I added the middleware to a group of routes

    Route::prefix('users')->group(function () {
        Route::get('/', [UserController::class, 'index']);
        Route::post('/', [UserController::class, 'store']);

        Route::prefix('{user}')->group(function () {
            Route::get('/', [UserController::class, 'show']);
            Route::patch('/', [UserController::class, 'update']);
            Route::delete('/', [UserController::class, 'destroy']);
        });
    });

});

And you're done! Told you it was easy :)

Now every route that goes through DebuggerMiddleware will be investigated and reported back to you.

Let's see an example

After setting APP_DEBUG key to true and requesting a route with debugger middleware on top of it, you'll be presented a response like this.

I tried /users/1 as an example.

Make sure to send the Accept header as application/json otherwise debugger won't look into the request.

{
  "data": {
    "id": 1,
    "name": "Demo User",
    "email": "user@test.com"
  },
  "debugger": {
    "server": {
      "web_server": "PHP 8.1.0 Development Server",
      "protocol": "HTTP/1.1",
      "remote_address": "127.0.0.1",
      "remote_port": "64714",
      "server_name": "127.0.0.1",
      "server_port": "8000"
    },
    "app": {
      "environment": "local",
      "laravel_version": "8.83.18",
      "php_version": "8.0.13",
      "locale": "fa"
    },
    "request": {
      "ip": "127.0.0.1",
      "uri": "/users/1",
      "method": "GET",
      "body": [],
      "headers": {
        "accept": ["application/json"],
        "user-agent": ["PostmanRuntime/7.29.2"],
        "cache-control": ["no-cache"],
        "postman-token": ["33ba20a5-db9a-4035-a593-4f32774e0854"],
        "host": ["localhost:8000"],
        "accept-encoding": ["gzip, deflate, br"],
        "connection": ["keep-alive"]
      }
    },
    "session": {
      "authenticated": false,
      "token": null
    },
    "queries": {
      "count": 1,
      "data": [
        {
          "query": "select * from `users` where `id` = ? limit 1",
          "bindings": ["1"],
          "time": 0.83
        }
      ]
    }
  }
}

I hope this package helps you with debugging your JSON APIs as it has helped me many times now.

Be sure to open an issue if you encounter anything out of the ordinary.

Feel free to add ideas to the package to improve its functionality for others.

hesamrad / laravel-api-debugger

Maintainers

Details