PHPackages                             saad/api-debugger - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. saad/api-debugger

ActiveLibrary[Framework](/categories/framework)

saad/api-debugger
=================

Easily debug your JSON API.

4.2.1(1y ago)1170.1k↓23.1%3MITPHPPHP >=5.6.0

Since Oct 16Pushed 1y ago1 watchersCompare

[ Source](https://github.com/ahmad-sa3d/lumen-api-debugger)[ Packagist](https://packagist.org/packages/saad/api-debugger)[ RSS](/packages/saad-api-debugger/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (4)Versions (8)Used By (0)

API-Debugger
============

[](#api-debugger)

[![Travis](https://camo.githubusercontent.com/93e9bdc997124001df0d8bf7f2dc91869204ec9f36382397ecdf5eddb4db9b37/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f727573742d6c616e672f727573742e737667)](https://travis-ci.org/mlanin/laravel-api-debugger)

> Easily debug your JSON API.

**This Package is an enhancement of [Laravel-API-Debugger](https://github.com/mlanin/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` = 'john.doe@acme.com' 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": [
      "foo",
      [
        1,
        2,
        "bar"
      ]
    ]
  }
}
```

Installation
------------

[](#installation)

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

[PHP](https://php.net) >=5.5.9+ or [HHVM](http://hhvm.com) 3.3+, [Composer](https://getcomposer.org) and [Laravel](http://laravel.com) 5.4+ are required.

Installation

```
composer require saad/api-debugger

```

#### For Lumen

[](#for-lumen)

1- Register the package service provider

```
// bootstrap/app.php
 $app->register(Lanin\Laravel\ApiDebugger\ServiceProvider::class);
```

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
 $app->configure('api-debugger');
```

#### For Laravel 5.4

[](#for-laravel-54)

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

```
Lanin\Laravel\ApiDebugger\ServiceProvider::class,
```

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

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

#### For Laravel 5.5

[](#for-laravel-55)

package supports [package discovery](https://laravel.com/docs/5.5/packages#package-discovery) feature.

Json response
-------------

[](#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

Debugging
---------

[](#debugging)

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

### Var dump

[](#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

[](#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.

#### QueriesCollection

[](#queriescollection)

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

#### CacheCollection

[](#cachecollection)

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

#### ProfilingCollection

[](#profilingcollection)

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

Automatically:

```
Debugger::profileMe('event-name', function () {
    sleep(1);
});
```

Or manually:

```
Debugger::startProfiling('event-name');
usleep(300);
Debugger::stopProfiling('event-name');
```

Also helpers are available:

```
lad_pr_start();
lad_pr_stop();
lad_pr_me();
```

### Extending

[](#extending)

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).

Contributing
------------

[](#contributing)

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

###  Health Score

43

—

FairBetter than 91% of packages

Maintenance41

Moderate activity, may be stable

Popularity38

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 76.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~440 days

Recently: every ~542 days

Total

7

Last Release

497d ago

PHP version history (2 changes)5.1.x-devPHP >=5.4.0

4.0.0PHP >=5.6.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/7927d2c9296987c6329eeda722cee82eb4622cff56b2b628f6a698a05e9ddad1?d=identicon)[ahmad-sa3d](/maintainers/ahmad-sa3d)

---

Top Contributors

[![mlanin](https://avatars.githubusercontent.com/u/467159?v=4)](https://github.com/mlanin "mlanin (43 commits)")[![ahmad-sa3d](https://avatars.githubusercontent.com/u/8466669?v=4)](https://github.com/ahmad-sa3d "ahmad-sa3d (11 commits)")[![mannysoft](https://avatars.githubusercontent.com/u/774913?v=4)](https://github.com/mannysoft "mannysoft (1 commits)")[![MASNathan](https://avatars.githubusercontent.com/u/2139464?v=4)](https://github.com/MASNathan "MASNathan (1 commits)")

---

Tags

logjsonapiframeworklaraveldebugdumplumendebuggerqueries

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/saad-api-debugger/health.svg)

```
[![Health](https://phpackages.com/badges/saad-api-debugger/health.svg)](https://phpackages.com/packages/saad-api-debugger)
```

###  Alternatives

[lanin/laravel-api-debugger

Easily debug your JSON API.

2311.8M](/packages/lanin-laravel-api-debugger)[laravel-lang/publisher

Localization publisher for your Laravel application

2167.7M24](/packages/laravel-lang-publisher)[lanin/laravel-api-exceptions

All in one solution for exception for JSON REST APIs on Laravel and Lumen.

40102.4k](/packages/lanin-laravel-api-exceptions)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)