Download the PHP package pinkeen/api-debug-bundle without Composer
On this page you can find all versions of the php package pinkeen/api-debug-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api-debug-bundle
ApiDebugBundle
This bundle adds a web debug toolbar tab which displays information about API consumer requests.
It aims to be universal and allow for easy integration with SDKs and HTTP client libraries.
Currently it supports Guzzle 6 out-of-the box.
It should be extremely easy to integrate with any http client using PSR-7 messages.
For Guzzle4-compatible version use the v1.0 tag.
For Symfony < 3.3-compatible version use the v2.0 tag.
Requirements
- PHP 5.5.9
- Symfony 3.3
Installation
The usual Symfony stuff.
The composer.json needs: "pinkeen/api-debug-bundle": "dev-master",.
The AppKernel.php needs: new Pinkeen\ApiDebugBundle\PinkeenApiDebugBundle(),.
Add the following to your app/config/routing_dev.yml if you want to be able to view raw body data:
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().
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.
Usage
Integrate with your custom client
Firstly you have to subclass
AbstractCallData
which holds data from a single API request.
If you are using a PSR-7 comptible client then you can use PsrCallData
instead of writing your own data class.
Then every time your API consumer makes a request dispatch an ApiEvents::API_CALL event.
Guzzle
You've got two options here, either:
Let the bundle create the client for you...
... or push the collector handler to your middleware stack.
RingPHP
Let the bundle create the handler for you:
Use the collector_middleware service to create your RingPHP middleware and wrap it around your base handler:
PS Nicely integrates with elasticsearch-php 2.0.
Production
For production environment you probably want to skip all of the data gathering.
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.
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.
All versions of api-debug-bundle with dependencies
symfony/framework-bundle Version >=3.3
symfony/symfony Version >=3.3
psr/http-message Version ~1.0
guzzlehttp/psr7 Version ~1.0