How to Build RESTful APIs in Laravel from Scratch

Laravel
28 Jan 2025 07:04 PM

Creating a RESTful API in Laravel is a common requirement for building scalable and structured web applications. In this guide, I’ll walk you through a step-by-step process to build a RESTful API in Laravel.

Step 1: Install Laravel

Start by installing Laravel using Composer. Run the following command in your terminal:

composer create-project laravel/laravel rest-api

Navigate into the project directory:

cd rest-api

Step 2: Set Up Database

  1. Create a database for your API.
  2. Update your .env file with the database credentials:
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=rest_api
DB_USERNAME=root
DB_PASSWORD=yourpassword

Run migrations to set up the default Laravel tables:

php artisan migrate

Step 3: Create a Model and Migration

For example, to manage a "Post" resource:

php artisan make:model Post -m

This command creates a model and a migration file. Open the migration file in database/migrations/ and define the table structure:

Schema::create('posts', function (Blueprint $table) {
    $table->id();
    $table->string('title');
    $table->text('content');
    $table->timestamps();
});

Run the migration:

php artisan migrate

Step 4: Add Data Using a Seeder (Optional)

To populate the database with test data, create a seeder:

php artisan make:seeder PostSeeder

In the PostSeeder file, add:

use App\Models\Post;

Post::create([
    'title' => 'First Post',
    'content' => 'This is the content of the first post.',
]);

Run the seeder:

php artisan db:seed --class=PostSeeder

Step 5: Set Up API Routes

Laravel provides an api.php file for API-specific routes. Open routes/api.php and define routes for the "Post" resource:

use App\Http\Controllers\Api\PostController;

Route::apiResource('posts', PostController::class);

Step 6: Create a Controller

Generate a controller with API methods:

php artisan make:controller Api/PostController --api

This creates a controller with predefined methods (index, store, show, update, destroy). Open the PostController file and implement these methods:

namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\Request;

class PostController extends Controller
{
    public function index()
    {
        return response()->json(Post::all(), 200);
    }

    public function store(Request $request)
    {
        $validated = $request->validate([
            'title' => 'required|string|max:255',
            'content' => 'required|string',
        ]);

        $post = Post::create($validated);
        return response()->json($post, 201);
    }

    public function show($id)
    {
        $post = Post::find($id);
        if (!$post) {
            return response()->json(['message' => 'Post not found'], 404);
        }
        return response()->json($post, 200);
    }

    public function update(Request $request, $id)
    {
        $post = Post::find($id);
        if (!$post) {
            return response()->json(['message' => 'Post not found'], 404);
        }

        $validated = $request->validate([
            'title' => 'string|max:255',
            'content' => 'string',
        ]);

        $post->update($validated);
        return response()->json($post, 200);
    }

    public function destroy($id)
    {
        $post = Post::find($id);
        if (!$post) {
            return response()->json(['message' => 'Post not found'], 404);
        }

        $post->delete();
        return response()->json(['message' => 'Post deleted'], 200);
    }
}

Step 7: Test the API

Use tools like Postman or cURL to test your API endpoints:

  • GET /api/posts - List all posts.
  • POST /api/posts - Create a new post (requires title and content).
  • GET /api/posts/{id} - Get a single post by ID.
  • PUT /api/posts/{id} - Update a post.
  • DELETE /api/posts/{id} - Delete a post.

Step 8: Enable API Authentication (Optional)

Laravel provides Sanctum for API authentication. Install it using:

composer require laravel/sanctum

Follow the Laravel Sanctum Documentation for setting up authentication.

Step 9: Refactor and Optimize

  • Use Transformers or Resources to format the response data.
  • Implement error handling with custom exception handling or middleware.
  • Add validation rules for better data integrity.

Conclusion

Building a RESTful API in Laravel involves configuring routes, controllers, and models while ensuring proper data validation and formatting. Following this guide, you can create a well-structured API from scratch. As you grow, you can integrate authentication, rate limiting, and other features to enhance your API.

2
27