Lecture Notes Of Day 13 - Laravel API Development

 

Lecture Notes Of Day 13 

Laravel API Development

Objective:

To learn how to build RESTful APIs in Laravel.

Expected Outcome:

By the end of the session, students will be able to create APIs for performing CRUD (Create, Read, Update, Delete) operations in Laravel.

Introduction to Laravel API Development

Laravel provides robust features for API development, including tools to create RESTful APIs efficiently. RESTful APIs are architectural principles for designing networked applications that use HTTP methods (GET, POST, PUT, DELETE) to perform CRUD operations.

What is a RESTful API?

RESTful APIs:

  • Stand for Representational State Transfer.
  • Allow communication between the client and server using HTTP protocols.
  • Use standard HTTP methods like:
    • GET: Retrieve data.
    • POST: Add new data.
    • PUT/PATCH: Update existing data.
    • DELETE: Remove data.

Laravel makes building RESTful APIs simple with its built-in Route::apiResource functionality.

Step-by-Step Guide to Building RESTful APIs in Laravel

1. Setting Up the Project

Before starting API development:

1.  Ensure Laravel is installed.

2.  Open the terminal in your Laravel project directory.

2. Create a Model and Migration

1.  Run the following command to create a model for the resource (e.g., Product):

bash

Copy code

php artisan make:model Product -m

This will create a Product model and a migration file.

2.  Define the schema for your resource in the migration file:

php

Copy code

public function up()

{

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

        $table->id();

        $table->string('name');

        $table->text('description');

        $table->decimal('price', 8, 2);

        $table->timestamps();

    });

}

3.  Migrate the database:

bash

Copy code

php artisan migrate

3. Create a Controller

Use the --api flag to generate a controller specifically for API functionality:

bash

Copy code

php artisan make:controller ProductController --api

The ProductController will handle all API requests.

4. Define API Routes

Laravel provides the Route::apiResource method to define RESTful routes for a resource in a single line:

php

Copy code

use Illuminate\Support\Facades\Route;

 

Route::apiResource('products', ProductController::class);

This automatically creates routes for:

  • GET /products - Retrieve all products.
  • GET /products/{id} - Retrieve a single product by ID.
  • POST /products - Create a new product.
  • PUT /products/{id} - Update a product by ID.
  • DELETE /products/{id} - Delete a product by ID.

5. Implement CRUD Methods in the Controller

Add logic to handle API requests in ProductController:

  • Index Method (GET /products): Retrieve all products.

php

Copy code

public function index()

{

    return Product::all();

}

  • Show Method (GET /products/{id}): Retrieve a single product.

php

Copy code

public function show($id)

{

    return Product::findOrFail($id);

}

  • Store Method (POST /products): Add a new product.

php

Copy code

public function store(Request $request)

{

    $validated = $request->validate([

        'name' => 'required',

        'description' => 'required',

        'price' => 'required|numeric',

    ]);

 

    return Product::create($validated);

}

  • Update Method (PUT /products/{id}): Update an existing product.

php

Copy code

public function update(Request $request, $id)

{

    $product = Product::findOrFail($id);

    $validated = $request->validate([

        'name' => 'required',

        'description' => 'required',

        'price' => 'required|numeric',

    ]);

 

    $product->update($validated);

    return $product;

}

  • Destroy Method (DELETE /products/{id}): Delete a product.

php

Copy code

public function destroy($id)

{

    $product = Product::findOrFail($id);

    $product->delete();

 

    return response()->json(['message' => 'Product deleted successfully']);

}

6. Test the APIs Using Postman

Postman is a tool for testing APIs. Follow these steps:

1.  Open Postman and create a new request.

2.  Set the HTTP method (GET, POST, PUT, DELETE).

3.  Provide the endpoint URL (e.g., http://127.0.0.1:8000/api/products).

4.  Add any necessary headers (e.g., Content-Type: application/json).

5.  For POST/PUT requests, add a JSON body:

json

Copy code

{

    "name": "Sample Product",

    "description": "This is a test product.",

    "price": 99.99

}

6.  Click Send to test the API.

7. Middleware for Authentication (Optional)

To secure your APIs, you can add middleware like auth:sanctum to routes:

php

Copy code

Route::middleware('auth:sanctum')->apiResource('products', ProductController::class);

Summary

  • Laravel simplifies RESTful API development with Route::apiResource.
  • CRUD operations are implemented using controller methods.
  • Use Postman to test and debug APIs.
  • Secure APIs with middleware for authentication if needed.

Assignment

1.  Create a Category API following the same process.

2.  Implement all CRUD operations for categories.

3.  Test the APIs using Postman.


Comments

Post a Comment

Popular posts from this blog

MCQs Of Day CRUD 8 Operations with Eloquent

MCQs Of Day 8 CRUD  Operations with Eloquent   CRUD Operations with Eloquent - MCQs 1. What does CRUD stand for in database management? a) Create, Read, Update, Delete b) Connect, Retrieve, Update, Delete c) Create, Return, Update, Delete d) Collect, Read, Update, Delete Answer:  a) Create, Read, Update, Delete Explanation:  CRUD is a set of operations that stand for Create, Read, Update, and Delete, which are basic functions used in databases to manage records. 2. Which Laravel method is used to create a new record in a database? a) create() b) store() c) insert() d) add() Answer:  a) create() Explanation:  The create() method is used in Laravel's Eloquent ORM to create a new record in the database. 3. Which of the following is true about Eloquent ORM in Laravel? a) It allows only raw SQL queries. b) It does not support relationships between models. c) It provides an active record implementation for working with the database. d) It is used only for Read op...
Read more

Lecture Notes Of Day 24: Laravel Policies

  Lecture Notes Of Day 24: Laravel Policies Objective: To implement policies for authorization, ensuring that different users can perform only the actions they are authorized to do. This will help students understand how to manage user permissions effectively for different actions in Laravel applications. Outcome: By the end of this class, students will be able to create, register, and use policies to manage user permissions for various actions in a Laravel application. They will also learn how to secure resources and actions based on user roles or other attributes. What are Policies in Laravel? In Laravel, policies provide a convenient way to authorize user actions on certain resources. A policy is essentially a class that organizes authorization logic for a particular model. For example, if you have a Post model, you might have a PostPolicy class that defines who can view, update, or delete a post. Why use Policies? Policies centralize authorization ...
Read more

MCQs of Day 7 Eloquent ORM Basics

  MCQs of Day 7 Eloquent ORM Basics 1. Which command is used to create an Eloquent model in Laravel? A) php artisan create:model B) php artisan make:model C) php artisan model:create D) php artisan generate:model Answer: B) php artisan make:model Explanation: The php artisan make:model command is used to create a new Eloquent model in Laravel. 2. What is the purpose of the $fillable property in an Eloquent model? A) To define which fields can be mass-assigned B) To define the table name C) To store timestamps D) To define relationships between models Answer: A) To define which fields can be mass-assigned Explanation: The $fillable property in an Eloquent model defines which fields are allowed for mass-assignment to protect against mass-assignment vulnerabilities. 3. How do you retrieve a single record by its ID in Eloquent? A) Model::get(1) B) Model::find(1) C) Model::single(1) D) Model::first(1) Answer: B) Model::find(1) Explanation: The find() method retrieves a single record by ...
Read more