pinkeen/api-debug-bundle

Allows easy API consumer debugging with web debug toolbar extension.

ApiDebugBundle

, _(*1)

This bundle adds a web debug toolbar tab which displays information about API consumer requests., _(*2)

It aims to be universal and allow for easy integration with SDKs and HTTP client libraries., _(*3)

Currently it supports Guzzle 6 out-of-the box., _(*4)

It should be extremely easy to integrate with any http client using PSR-7 messages., _(*5)

For Guzzle4-compatible version use the v1.0 tag., _(*6)

For Symfony < 3.3-compatible version use the v2.0 tag., _(*7)

Requirements

• PHP 5.5.9
• Symfony 3.3

Installation

The usual Symfony stuff., _(*8)

The composer.json needs: "pinkeen/api-debug-bundle": "dev-master",., _(*9)

The AppKernel.php needs: new Pinkeen\ApiDebugBundle\PinkeenApiDebugBundle(),., _(*10)

Add the following to your app/config/routing_dev.yml if you want to be able to view raw body data:, _(*11)

_api_debug:
    resource: "@PinkeenApiDebugBundle/Resources/config/routing.yml"
    prefix:   /_profiler

Services

New symfony approach

All services expect GuzzleClientFactory and RingPHPHandlerFactory are private, which means you cannot fetch services directly from the container via $container->get()., _(*12)

They are also automatically registered and set to autowire, all you need to do add type-hinted service to your class as an argument of contructor., _(*13)

// src/AppBundle/Service/FooService.php
// ...

use Pinkeen\ApiDebugBundle\Bridge\Guzzle\Middleware\DataCollectorMiddleware;

class FooService
{
    private $dataCollectorMiddleware;

    public function __construct(DataCollectorMiddleware $dataCollectorMiddleware)
    {
        $this->dataCollectorMiddleware = $dataCollectorMiddleware;
    }

    // ...
}

Usage

Integrate with your custom client

Firstly you have to subclass AbstractCallData which holds data from a single API request., _(*14)

If you are using a PSR-7 comptible client then you can use PsrCallData instead of writing your own data class., _(*15)

Then every time your API consumer makes a request dispatch an ApiEvents::API_CALL event., _(*16)

    use Pinkeen\ApiDebugBundle\ApiEvents;
    use Pinkeen\ApiDebugBundle\Event\ApiCallEvent;

    /* ... */
    /** @var $eventDispatcher \Symfony\Component\EventDispatcher\EventDispatcher */
    $eventDispatcher->dispatch(
        ApiEvents::API_CALL, 
        new ApiCallEvent(
            new YourApiCallData(/* your params */)
        )
    );

Guzzle

You've got two options here, either:, _(*17)

Let the bundle create the client for you..., _(*18)

    /** @var $guzzleClientFactory \Pinkeen\ApiDebugBundle\Bridge\Guzzle\Service\GuzzleClientFactory */
    $guzzleClientFactory->create([
        /* Guzzle client config (optional).
         * It is passed directly to GuzzleHttp\Client constructor. */
    ]);

... or push the collector handler to your middleware stack., _(*19)

    $handler = new GuzzleHttp\HandlerStack(new GuzzleHttp\Handler\CurlHandler());
    /** @var $dataCollectorMiddleware \Pinkeen\ApiDebugBundle\Bridge\Guzzle\Middleware\DataCollectorMiddleware */
    $dataCollectorMiddlewareHandler = $dataCollectorMiddleware->getHandler();
    $handler->push($dataCollectorMiddlewareHandler);
    $client = new GuzzleHttp\Client(['handler' => $handler]);

RingPHP

Let the bundle create the handler for you:, _(*20)

    /** @var $ringPHPHandlerFactory \Pinkeen\ApiDebugBundle\Bridge\RingPHP\Service\RingPHPHandlerFactory */
    $handler = $ringPHPHandlerFactory->create(new CurlHandler());

Use the collector_middleware service to create your RingPHP middleware and wrap it around your base handler:, _(*21)

    /** @var $dataCollectorMiddleware \Pinkeen\ApiDebugBundle\Bridge\RingPHP\Middleware\DataCollectorMiddleware */
    $ringPhpHandler = $dataCollectorMiddleware->createHandler(new GuzzleHttp\Ring\Client\CurlHandler(), 'apiname');

PS Nicely integrates with elasticsearch-php 2.0., _(*22)

Production

For production environment you probably want to skip all of the data gathering., _(*23)

You should take care of that yourself, unless you're using Pinkeen\ApiDebugBundle\Bridge\Guzzle\Service\GuzzleClientFactory or Pinkeen\ApiDebugBundle\Bridge\RingPHP\Service\RingPHPHandlerFactory which skip it when not in debug mode., _(*24)

Notes

I haven't found an easy way to get call duration out of guzzle6, so there's a regression here. If anybody has an idea please give me a shout., _(*25)