devfactory/api

RESTful API package

Api

Helpers to create an API for laravel 4.2, _(*1)

This module handle json and xml as response, _(*2)

, _(*3)

How to setup

update composer.json file:, _(*4)

{
    "require": {
        "devfactory/api": "1.0.*"
    }
}

and run composer update from terminal to download files., _(*5)

update app.php file in app/config directory:, _(*6)

'providers' => array(
  'Devfactory\Api\ApiServiceProvider',
),

alias => array(
    'API'          => 'Devfactory\Api\Facades\ApiFacade',
),

Configuration

 php artisan config:publish devfactory/api

How to use api

in your route, _(*7)

the param {format} are not mandatory, _(*8)

Route::group(array('prefix' => 'v1'), function()
{
    Route::get('foo.{format}', 'ApiV1\FooController@foo');
    Route::post('bar.{format}', 'ApiV1\FooController@bar');
});

Route::group(array('prefix' => '{format}/v1'), function()
{
    Route::get('foo', 'ApiV1\FooController@foo');
    Route::post('bar', 'ApiV1\FooController@bar');
});

In you controller you can use, _(*9)

  return Response::api(array("foo" => "bar"), 404);
  return Response::api(array("ok"));

or, _(*10)

  return API::createResponse(array("foo" => "bar"), 404);
  return API::createResponse(array("ok"));

To call your service you can use the Facade

  API::get('v1/foo.json', array('foo' => 'bar'));
  API::post('v1/bar.xml', array('foo' => 'bar'));
  API::put('v1/bar.xml', array('foo' => 'bar'));