library api {🖫 18,357, ⚐ 4, ★ 72}

teepluss/api

Laravel 4 Internal Request (HMVC)

Friday, March 4, 2016
by Teepluss
Repository
5 Watchers
72 Stars
18,357 Installations

PHP
0 Dependents
0 Suggesters
27 Forks
2 Open issues
4 Versions
7 % Grown

The README.md

Laravel HMVC.

This package is no longer updated anymore, Now I've splited this package into 2. - HMVC - RESTful format, _(*1)

API is a tool for making internal request (HMVC)., _(*2)

Installation

To get the lastest version of Theme simply require it in your composer.json file., _(*3)

"teepluss/api": "dev-master"

You'll then need to run composer install to download it and have the autoloader updated., _(*4)

Once Theme is installed you need to register the service provider with the application. Open up app/config/app.php and find the providers key., _(*5)

'providers' => array(

    'Teepluss\Api\ApiServiceProvider'

)

API also ships with a facade which provides the static syntax for creating collections. You can register the facade in the aliases key of your app/config/app.php file., _(*6)

'aliases' => array(

    'API' => 'Teepluss\Api\Facades\API'

)

Publish config using artisan CLI., _(*7)

php artisan config:publish teepluss/api

Usage

API helping you to work with internal request., _(*8)

Internal testing request
Calling via artisan CLI
Create reponses format for RESTful

Internal testing request.

// GET Request.
API::get('user/1');

// POST Request.
API::post('user', array('title' => 'Demo'));

// PUT Request.
API::put('user/1', array('title' => 'Changed'));

// DELETE Request.
API::delete('user/1');

// Internal request with domain route.
API::invoke('http://api.domain.com', 'post', array('param' => 1))

// You can make remote request without changing code also.
API::post('http://api.github.com', array('username' => 'teepluss'));

// Request remote with invokeRemote.
API::invokeRemote('http://api.github.com', 'post', array('username' => 'teepluss'));

// Get Guzzle to use other features.
$guzzle = API::getRemoteClient();

Remote request using Guzzle as an adapter., _(*9)

Calling via artisan CLI.

// Internal GET.
$ php artisan api:call --request GET /some/route?param=value

// Internal POST.
$ php artisan api:call --request POST /some/form --data "name=Tee"

// Remote request.
$ php artisan api:call --request GET http://google.com

also work with DELETE, PATCH, HEAD, _(*10)

Create reponses format for RESTful.

// Response entries.
$users = User::all();
API::createResponse($users);

// Response entry.
$user = User::find($id);
return API::createResponse($user);

// Response Laravel error.
$errors = $validation->messages()->all(':message');
return API::createResponse(compact('errors'), 400);

// Response created data.
$user = Url::create($data);
return API::createResponse($user, 201);

// Response 404.
API::createResponse("User [$id] was not found.", 404);

//Response deleted.
API::createResponse(null, 204);