آموزش ساخت یک REST API ساده با لاراول

لاراول یکی از محبوب‌ترین فریم‌ورک‌های PHP است که ساخت REST API را به لطف ابزارهای قدرتمند خود ساده‌تر کرده است. در این آموزش، یک API ساده برای مدیریت اطلاعات کاربران ایجاد خواهیم کرد.

گام اول: نصب لاراول

برای شروع، ابتدا باید لاراول را نصب کنید. اگر هنوز لاراول را نصب نکرده‌اید، می‌توانید این کار را با استفاده از Composer انجام دهید:

composer create-project --prefer-dist laravel/laravel rest_api

پس از نصب، وارد پوشه پروژه شوید:

cd rest_api

گام دوم: تنظیم فایل ENV

مطمئن شوید که تنظیمات اتصال به دیتابیس در فایل .env انجام شده باشد. به عنوان مثال:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=rest_api_db
DB_USERNAME=your_username
DB_PASSWORD=your_password

گام سوم: ساخت مدل و Migration

مدلی برای کاربران ایجاد کنید:

php artisan make:model User -m

این دستور یک مدل به نام User و یک فایل migration مرتبط ایجاد می‌کند. حالا فایل مهاجرت را باز کنید (در مسیر database/migrations) و فیلدهای جدول کاربران را تعریف کنید:

public function up()
{
    Schema::create('users', function (Blueprint $table) {
        $table->id();
        $table->string('name');
        $table->string('email')->unique();
        $table->string('password');
        $table->timestamps();
    });
}

سپس migration را اجرا کنید:

php artisan migrate

گام چهارم: ایجاد کنترلر برای API

یک کنترلر جدید با نام UserController ایجاد کنید:

php artisan make:controller UserController

سپس داخل کنترلر متدهای CRUD (ایجاد، خواندن، به‌روزرسانی و حذف) را اضافه کنید. نمونه‌ای از متد برای دریافت تمام کاربران:

use App\Models\User;

public function index()
{
    return response()->json(User::all(), 200);
}

گام پنجم: تعریف مسیرها

مسیرهای مربوط به API را در فایل routes/api.php تعریف کنید. به عنوان مثال:

use App\Http\Controllers\UserController;

Route::get('/users', [UserController::class, 'index']);
Route::post('/users', [UserController::class, 'store']);
Route::get('/users/{id}', [UserController::class, 'show']);
Route::put('/users/{id}', [UserController::class, 'update']);
Route::delete('/users/{id}', [UserController::class, 'destroy']);

این مسیرها به کنترلر UserController مرتبط هستند.

گام ششم: آزمایش API

برای آزمایش، می‌توانید از ابزارهایی مانند Postman استفاده کنید:

1. ارسال درخواست GET به آدرس /api/users برای دریافت لیست کاربران
2. ارسال درخواست POST به /api/users برای ایجاد کاربر جدید.
3. ارسال درخواست PUT یا DELETE برای به‌روزرسانی یا حذف کاربران.