jdecano/api

There is no license information available for the latest version (dev-master) of this package.

dev-master 2014-09-19 00:48 UTC

Requires

• php: >=5.4.0

Requires (Dev)

• phpspec/phpspec: ~2.0

Unknown License

• John Dave Decano

README

A simple package that will help you save your time to create a basic RESTful API for Laravel.

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

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.

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

PATH - /api/1.0/users

PARAMS

1. limit = N

2. index = Where to start

3. where = Find by column e.g first_name|=|Dave

4. like = Search by column e.g first_name=Dave

RETURNS - JSON

Create User

METHOD - POST

PATH - /api/1.0/users

PARAMS - The column names. Note : Make sure your columns are fillable.

RETURNS - JSON

Update User

METHOD - PUT/PATCH

PATH - /api/1.0/users/{id}

PARAMS - The column names. Note : Make sure your columns are fillable.

RETURNS - JSON

DELETE User

METHOD - DELETE

PATH - /api/1.0/users/{id}

RETURNS - JSON

Authentication

Wrap your routes with a filter. Heres an example:

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!
});