hvent90 / api-inspector by hvent90

Streams API requests
49
0
2
Package Data
Maintainer Username: hvent90
Maintainer Contact: hvent90@gmail.com (Henry Ventura)
Package Create Date: 2015-04-29
Package Last Update: 2015-04-29
Home Page:
Language: PHP
License: MIT
Last Refreshed: 2024-07-21 03:05:29
Package Statistics
Total Downloads: 49
Monthly Downloads: 0
Daily Downloads: 0
Total Stars: 0
Total Watchers: 2
Total Forks: 0
Total Open Issues: 0

Real time streaming API Inspector for Laravel with Pusher.


Table of Contents

In a Nutshell

- Install the package.

- Navigate with your browser to /api/inspect.

- You will now see HTTP requests being made to your application in real time. You do not need to refresh the browser.

Okay, that was the elevator shpiel. Here is the walkthrough of what is happening:

Hvent90/ApiInspector/ApiInspectorServiceProvider::boot() intercepts the $request object with $this->app[‘router’]->before([$this, ‘onBefore’]);.

Hvent90/ApiInspector/ApiInspectorServiceProvider::onBefore($request) takes the $request object and, after instantiating Pusher, uses Pusher to feed the data directly to hvent90/api-inspector/src/Http/views/stream.blade.php.

Installation

  • Add this package to your Laravel project by typing composer require hvent90/api-inspector in your command line.
  • Add 'Hvent90\ApiInspector\ApiInspectorServiceProvider' to the Providers array in config/app.php.
  • Publish the views and configuration file for easy modifications by typing php artisan vendor:publish in your command line. What does this do?
  • Enter in your Pusher access keys in config/api-inspector.php.

Default Usage

The URI endpoint of api/inspect will now load a view that streams all API requests in real time without refreshing the browser. Enjoy!

Configuration

You can configure the behavior of ApiInspector via config/api-inspector.php.

  • active accepts either true or false and will enable or disable ApiInspector
  • public, secret, and app_id take your Pusher keys
  • uri will determine what URI endpoint is associated with the route
  • prefix will add a prefix to the route
  • subdomain will add a subdomain to the route
  • middleware adds middleware to the route

The array called route-modifiers is directly injected in to a route group that governs the API Inspector's route. You can add custom key/value pairs to the route-modifiers array to suite your application's needs.

You can locate and customize the default views found in resources/views/vendors/hvent90/api-inspector.

Pusher Info

Visit https://pusher.com for more information on the Pusher service. It is quick, easy, and awesome. My implementation of Pusher in this package can be understood through Jeffrey Wayes' (of Laracasts.com) great video tutorial great video tutorial