onlinecode

Create restful APIs using Laravel 5 with resourceful routes example

onlinecode

Create restful APIs using Laravel 5 with resourceful routes example

In this post we will give you information about Create restful APIs using Laravel 5 with resourceful routes example. Hear we will give you detail about Create restful APIs using Laravel 5 with resourceful routes exampleAnd how to use it also give you demo for it if it is necessary.

Create restful API using Laravel 5 with resourceful routes example

It was hard for me to create rest API before but Laravel have developed with rest API concept.

In this tutorial, i will tell you how to create rest API in Laravel with resourceful routes for create, read, update and delete records.

REST known as Representational State Transfer. A REST API basically define set of method which handle request of client and generate responses via HTTP protocol such as GET and POST.

Here i write a rest api in Laravel which return in response of JSON format.

You can create rest APIs in minutes with Laravel.

If you want to quickly create your first test API with Laravel then open your routes.php and paste this code to see the response of API.

  1. Route::get('sample-restful-apis',function()
  2. {
  3. returnarray(
  4. 1=>"onlinecode",
  5. 2=>"demo"
  6. );
  7. });
Route::get('sample-restful-apis', function()
{
    return array(
      1 => "onlinecode",
      2 => "demo"
    );
});

When you run your URL with above route in browser then you will see the response in JSON-encoded string.

Here is response of above route :

  1. {
  2. "1":"onlinecode",
  3. "2":"demo"
  4. }
{
    "1": "onlinecode",
    "2": "demo"
}

OK, let’s start to create resourceful route : 

  1. Route::group(array('prefix'=>'api'),function(){
  2.     Route::resource('restful-apis','APIController');
  3. });
Route::group(array('prefix' => 'api'), function() {
    Route::resource('restful-apis','APIController');
});

Here i add prefix api for all restful api that means all routes for rest api will be written within group with prefix api.

See also  How to check if an string is empty in Swift

Note : don’t forget to exclude all routes start with api in your /app/Http/Middleware/VerifyCsrfToken.php otherwise you will get error of TokenMismatchException you may also disable CSRF while working with cURL to post something.

  1. protected $except=[
  2. 'api/*'
  3. ];
protected $except = [
      'api/*'
];

Now i will create a APIController.php where i will handle all request generated by resourceful routes.

  1. <?php
  2. namespace AppHttpControllers;
  4. use IlluminateHttpRequest;
  5. use AppHttpControllersController;
  6. use AppProduct;
  8. class APIController extends Controller
  9. {
  10.     public functionindex(Request $request)
  11. {
  12. $products= Product::paginate(5);
  13. returnresponse(array(
  14. 'error'=> false,
  15. 'products'=>$products->toArray(),
  16. ),200);
  17. }
  18.     public functionstore(Request $request)
  19. {
  21.         Product::create($request->all());
  22. returnresponse(array(
  23. 'error'=> false,
  24. 'message'=>'Product created successfully',
  25. ),200);
  26. }
  27.     public functionshow($id)
  28. {
  29. $product= Product::find($id);
  30. returnresponse(array(
  31. 'error'=> false,
  32. 'product'=>$product,
  33. ),200);
  34. }
  35.     public functionupdate(Request $request,$id)
  36. {
  38.         Product::find($id)->update($request->all());
  39. returnresponse(array(
  40. 'error'=> false,
  41. 'message'=>'Product updated successfully',
  42. ),200);
  43. }
  44.     public functiondestroy($id)
  45. {
  46.         Product::find($id)->delete();
  47. returnresponse(array(
  48. 'error'=> false,
  49. 'message'=>'Product deleted successfully',
  50. ),200);
  51. }
  52. }
  53. ?>
<?php
namespace AppHttpControllers;

use IlluminateHttpRequest;
use AppHttpControllersController;
use AppProduct;

class APIController extends Controller
{
    public function index(Request $request)
    {
        $products = Product::paginate(5);
        return response(array(
                'error' => false,
                'products' =>$products->toArray(),
               ),200);       
    }
    public function store(Request $request)
    {

        Product::create($request->all());
        return response(array(
                'error' => false,
                'message' =>'Product created successfully',
               ),200);
    }
    public function show($id)
    {
        $product = Product::find($id);
        return response(array(
                'error' => false,
                'product' =>$product,
               ),200);
    } 
    public function update(Request $request, $id)
    {

        Product::find($id)->update($request->all());
        return response(array(
                'error' => false,
                'message' =>'Product updated successfully',
               ),200);
    }
    public function destroy($id)
    {
        Product::find($id)->delete();
        return response(array(
                'error' => false,
                'message' =>'Product deleted successfully',
               ),200);
    }
}
?>

Now create a Product model for products table.

  1. <?php
  2. namespace App;
  3. use IlluminateDatabaseEloquentModel;
  4. class Product extends Model
  5. {
  6.     public $fillable=['name','details'];
  7. }
<?php
namespace App;
use IlluminateDatabaseEloquentModel;
class Product extends Model
{
    public $fillable = ['name','details'];
}

Now i will show you response of each controller methods.

Response of index method

In this method i fetch product list.

  1. {
  2. "error":false,
  3. "status":,
  4. "products":{
  5. "total":17,
  6. "per_page":5,
  7. "current_page":1,
  8. "last_page":4,
  9. "next_page_url":"http://localhost/blog/public/restful-apis?page=2",
  10. "prev_page_url":null,
  11. "from":1,
  12. "to":5,
  13. "data":[
  14. {
  15. "id":1,
  16. "name":"product1",
  17. "details":"details of product1",
  18. "created_at":"2016-06-27 10:51:30",
  19. "updated_at":"2016-06-28 12:15:04"
  20. },
  21. {
  22. "id":2,
  23. "name":"onlinecode",
  24. "details":"onlinecode is a educational portal.",
  25. "created_at":"2016-06-24 10:53:57",
  26. "updated_at":"2016-06-24 10:54:48"
  27. },
  28. {
  29. "id":7,
  30. "name":"Laravel Restful APIs",
  31. "details":"Expertise in Laravel",
  32. "created_at":"2016-06-24 11:20:32",
  33. "updated_at":"2016-06-28 12:15:37"
  34. },
  35. {
  36. "id":8,
  37. "name":"product",
  38. "details":"demo product",
  39. "created_at":"2016-06-27 10:51:30",
  40. "updated_at":"2016-06-28 12:15:55"
  41. },
  42. {
  43. "id":11,
  44. "name":"CSRF",
  45. "details":"CSRF",
  46. "created_at":"2016-06-27 10:51:30",
  47. "updated_at":"2016-06-27 10:51:30"
  48. }
  49. ]
  50. }
  51. }
{
    "error": false,
    "status": 0,
    "products": {
        "total": 17,
        "per_page": 5,
        "current_page": 1,
        "last_page": 4,
        "next_page_url": "http://localhost/blog/public/restful-apis?page=2",
        "prev_page_url": null,
        "from": 1,
        "to": 5,
        "data": [
            {
                "id": 1,
                "name": "product1",
                "details": "details of product1",
                "created_at": "2016-06-27 10:51:30",
                "updated_at": "2016-06-28 12:15:04"
            },
            {
                "id": 2,
                "name": "onlinecode",
                "details": "onlinecode is a educational portal.",
                "created_at": "2016-06-24 10:53:57",
                "updated_at": "2016-06-24 10:54:48"
            },
            {
                "id": 7,
                "name": "Laravel Restful APIs",
                "details": "Expertise in Laravel",
                "created_at": "2016-06-24 11:20:32",
                "updated_at": "2016-06-28 12:15:37"
            },
            {
                "id": 8,
                "name": "product",
                "details": "demo product",
                "created_at": "2016-06-27 10:51:30",
                "updated_at": "2016-06-28 12:15:55"
            },
            {
                "id": 11,
                "name": "CSRF",
                "details": "CSRF",
                "created_at": "2016-06-27 10:51:30",
                "updated_at": "2016-06-27 10:51:30"
            }
        ]
    }
}

Response of store method

In this method i create new product.

  1. {"error":false,"message":"Product created successfully"}
{"error":false,"message":"Product created successfully"}

Response of show method

In this method i can see the particular product details.

  1. {
  2. "error":false,
  3. "product":{
  4. "id":1,
  5. "name":"product1",
  6. "details":"details of product1",
  7. "created_at":"2016-06-27 10:51:30",
  8. "updated_at":"2016-06-28 12:15:04"
  9. }
  10. }
{
    "error": false,
    "product": {
        "id": 1,
        "name": "product1",
        "details": "details of product1",
        "created_at": "2016-06-27 10:51:30",
        "updated_at": "2016-06-28 12:15:04"
    }
}

Response of update method

In this method i update product details.

  1. {"error":false,"message":"Product updated successfully"}
{"error":false,"message":"Product updated successfully"}

Response of destroy method

In this method i delete the product.

  1. {"error":false,"message":"Product deleted successfully"}
{"error":false,"message":"Product deleted successfully"}

Now you can create easily restful API in Laravel by following above code. You can also authentication your routes with unique token which you will get after login. Token will generate each time after login in application. Mobile application always prefer REST API.

Label :

PHP

Laravel PHP Framework

How To

API

Hope this code and post will helped you for implement Create restful APIs using Laravel 5 with resourceful routes example. if you need any help or any feedback give it in comment section or you have good idea about this post you can give it comment section. Your comment will help us for help you more and improve us. we will give you this type of more interesting post in featured also so, For more interesting post and code Keep reading our blogs

For More Info See :: laravel And github

Exit mobile version