Easy debug for your JSON API

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. Laravel-API-Debugger is made to provide you with all your debug information and doesn’t corrupt the output.

Example

{
    "posts": [
        {
            "id": 1,
            "title": "Title 1",
            "body": "Body 1"
        },        
        {
            "id": 2,
            "title": "Title 2",
            "body": "Body 2"
        }
    ],
    "meta": {
        "total": 2
    },
    "debug": {
        "total_queries": 2,
        "queries": [
            {
                "query": "select * from `users` where `email` = 'john.doe@acme.com' limit 1;",
                "time": 0.38
            },
            {
                "query": "select * from `posts` where `author` = '1';",
                "time": 1.34
            },
        ],
        "dump": [
            "foo",
            [
                1,
                2,
                "bar"
            ]
        ]
    }
}

Installation

PHP 5.4+ or HHVM 3.3+, Composer and Laravel 5.0+ are required.

To get the latest version of Laravel Laravel-API-Debugger, simply add the following line to the require block of your composer.json file.

  "lanin/laravel-api-debugger": "~0.1"

Then you have to run composer install or composer update to download it and have the autoloader updated.

Once Laravel-API-Debugger is installed, you need to register the service provider. Open up config/app.php and add the following to the providers key.

'Lanin\ApiDebugger\DebuggerServiceProvider',

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

<?php

'Debugger' => 'Lanin\ApiDebugger\DebuggerFacade',

Debugging

Debugger’s two main tasks are to collect your SQL queries and dump variables.

Query log

Debugger can provide you with all SQL queries that were fired during the request.

It will listen to the illuminate.query event and add queries to the output.

Note! It will add queries log ONLY when you set APP_DEBUG=true. So you don’t have to worry that someone will see your queries on production.

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.

<?php

$foo = 'foo';
$bar = [1, 2, 'bar'];
\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.

Contributing

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

Star Fork