REST API using Lumen framework by Laravel

March 24, 2016 at 7:37 pm | By : Muhammad Syarif Catatanku, Laravel No comments

REST API using lumen framework by laravel

Directory Lumen

Installation Lumen via Composer :

composer create-project laravel/lumen --prefer-dist lumen-rest

1	composer create-project laravel/lumen --prefer-dist lumen-rest

If the packages are downloaded then we will start to modify app.php file which is located atbootstrap/app.php for enable or disable the features what we need. So we are going to enable Eloquent and Facade.

bootstrap/app.php(Changes)

$app->withFacades();
$app->withEloquent();

1 2	$app->withFacades(); $app->withEloquent();

Setting db using .env

APP_ENV=local
APP_DEBUG=true
APP_KEY=RandomKey

DB_CONNECTION=mysql
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=learn_lumen
DB_USERNAME=root
DB_PASSWORD=

CACHE_DRIVER=memcached
QUEUE_DRIVER=sync

APP_ENV=local

APP_DEBUG=true

APP_KEY=RandomKey

DB_CONNECTION=mysql

DB_HOST=localhost

DB_PORT=3306

DB_DATABASE=learn_lumen

DB_USERNAME=root

DB_PASSWORD=

CACHE_DRIVER=memcached

QUEUE_DRIVER=sync

Create Migration :

php artisan migrate:install

1	php artisan migrate:install

Create the migration table and the name table is articles

php artisan make:migration --create=articles create_articles_table

1	php artisan make:migration --create=articles create_articles_table

After run, edit file in database/migrations

2016_03_24_085156_create_articles_table.php

Code :

<?php

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateArticlesTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('articles', function (Blueprint $table) {
            $table->increments('id');
            $table->String('article_name');
            $table->text('article_description');
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::drop('articles');
    }
}

<?php

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Database\Migrations\Migration;

class CreateArticlesTable extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

Schema::create('articles', function (Blueprint $table) {

$table->increments('id');

$table->String('article_name');

$table->text('article_description');

$table->timestamps();

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

Schema::drop('articles');

}

and then run migrate

php artisan migrate

1	php artisan migrate

Create Model:

create article at app/ directory

file Article.php

<?php 
namespace App;

use Illuminate\Database\Eloquent\Model;

/**
* 
*/
class Article extends Model
{
	protected $table = 'articles';

	protected $fillable = ['article_name','article_description'];
}

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

/**

class Article extends Model

{

protected $table = 'articles';

protected $fillable = ['article_name','article_description'];

}

Create Controller:

create new ArticleController.php file to Http/Controller.

File ArticleController.php

<?php
 
namespace App\Http\Controllers;
 
use App\Article;
use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
 
 
class ArticleController extends Controller{
 
 
    public function getArticles()
    { 
        $articles  = Article::all(); 
        return response()->json($articles); 
    }
 
    public function getArticle($id)
    { 
        $article  = Article::find($id); 
        return response()->json($article);
    }
 
    public function saveArticle(Request $request)
    { 
        $article = Article::create($request->all()); 
        return response()->json($article); 
    }
 
    public function deleteArticle($id)
    {
        $article  = Article::find($id); 
        $article->delete(); 
        return response()->json([
            'success' => true
        ]);
    }
 
    public function updateArticle(Request $request, $id)
    {
        $article  = Article::find($id); 
        $article->article_name = $request->input('article_name');
        $article->article_description = $request->input('article_description'); 
        $article->save(); 
        return response()->json($article);
    }
 
}

<?php

namespace App\Http\Controllers;

use App\Article;

use App\Http\Controllers\Controller;

use Illuminate\Http\Request;

class ArticleController extends Controller{

public function getArticles()

{

$articles = Article::all();

return response()->json($articles);

}

public function getArticle($id)

{

$article = Article::find($id);

return response()->json($article);

}

public function saveArticle(Request $request)

{

$article = Article::create($request->all());

return response()->json($article);

}

public function deleteArticle($id)

{

$article = Article::find($id);

$article->delete();

return response()->json([

'success' => true

]);

}

public function updateArticle(Request $request, $id)

{

$article = Article::find($id);

$article->article_name = $request->input('article_name');

$article->article_description = $request->input('article_description');

$article->save();

return response()->json($article);

}

Setting Route :

File Routes

<?php

/*
|--------------------------------------------------------------------------
| Application Routes
|--------------------------------------------------------------------------
|
| Here is where you can register all of the routes for an application.
| It is a breeze. Simply tell Lumen the URIs it should respond to
| and give it the Closure to call when that URI is requested.
|
*/

// $app->get('/', function () use ($app) {
//     return $app->version();
// });

$app->group(['namespace' => 'App\Http\Controllers'] , function($app){
    $api = 'api';
    $app->get($api.'/', ['uses' => 'ArticleController@getArticles', 'as' => 'allArticles']);
    $app->get($api.'/article/{id}', ['uses' => 'ArticleController@getArticle', 'as' => 'singleArticle']);
    $app->post($api.'/article', ['uses' => 'ArticleController@saveArticle', 'as' => 'saveArticle']);
    $app->put($api.'/article/{id}', ['uses' => 'ArticleController@updateArticle', 'as' => 'updateArticle']);
    $app->delete($api.'/article/{id}', ['uses' => 'ArticleController@deleteArticle', 'as' => 'deleteArticle']);
});