devfactory/api

RESTful API package

Maintainers

Details

github.com/DevFactoryCH/api

Source

Issues

Installs: 599

Dependents: 1

Suggesters: 0

Security: 0

Stars: 1

Watchers: 5

Forks: 0

Open Issues: 1

1.0.5 2016-03-09 09:56 UTC

Requires

Requires (Dev)

MIT ed239aac6e15cba23ae527b1d175c478d2b7d6ae

  • Alcindo Da Costa <alcindo.dacosta.woop@devfactory.ch>

restapirestfullaravelLaravel 4

This package is auto-updated.

Last update: 2024-11-16 04:02:33 UTC

README

Helpers to create an API for laravel 4.2

This module handle json and xml as response

Latest Stable Version Total Downloads License

##How to setup

update composer.json file:

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

and run composer update from terminal to download files.

update app.php file in app/config directory:

'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

the param {format} are not mandatory

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

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

or

  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'));