jdecano/api

LaravelRESTAPIGenerator

A simple package that will help you save your time to create a basic RESTful API for Laravel., _(*1)

How to Install

1. First clone this package.
2. Edit your app.php and 'Jdecano\Api\ApiServiceProvider' to your available service providers.
3. Publish the config "php artisan config:publish jdecano/api"

Usage

php artisan api:make

Eloquent Model e.g User: User

Api Version e.g 1.0: 2.0

Configuration

The configuration is at app/config/packages/jdecano/api/paths.php, _(*2)

return [
    'controller_target_path'   => app_path('controllers'),
    'routes_file'              => app_path('routes.php')
];

Example Output

After your run the command it will generate the following., _(*3)

1. If you use User as your model, it will create ApiUserController.php
2. It will add Route::resource('api/1.0/users','ApiUserController'); at the end of the routes file.

Retrive Users

METHOD - GET, _(*4)

PATH - /api/1.0/users, _(*5)

PARAMS, _(*6)

1. limit = N, _(*7)

2. index = Where to start, _(*8)

3. where = Find by column e.g first_name|=|Dave, _(*9)

4. like = Search by column e.g first_name=Dave, _(*10)

RETURNS - JSON, _(*11)

Create User

METHOD - POST, _(*12)

PATH - /api/1.0/users, _(*13)

PARAMS - The column names. Note : Make sure your columns are fillable., _(*14)

RETURNS - JSON, _(*15)

Update User

METHOD - PUT/PATCH, _(*16)

PATH - /api/1.0/users/{id}, _(*17)

PARAMS - The column names. Note : Make sure your columns are fillable., _(*18)

RETURNS - JSON, _(*19)

DELETE User

METHOD - DELETE, _(*20)

PATH - /api/1.0/users/{id}, _(*21)

RETURNS - JSON, _(*22)

Authentication

Wrap your routes with a filter. Heres an example:, _(*23)

Basic HTTP Authentication

// routes.php
Route::group(array('before' => 'auth.basic', function()
{
    // Your route goes here
}));

// filters.php
Route::filter('auth.basic', function()
{
    return Auth::basic('username'); 
});

You can ask authentication from your request header

// routes.php
Route::group(array('before' => 'secure_token', function()
{
    // Your route goes here
}));

// filters.php
Route::filter('secure_token', function()
{
    $username = Request::header('username');
    $token = Request::header('token');

    // Then create some kind of validation here
    // If fails then send a 403 Response
    // Easy!
});