Laravelを使用してREST APIを作成する方法

こんにちは！このチュートリアルでは、タスクを管理するための完全な REST API を Laravel で構築します。プロジェクトの設定から自動テストの作成まで、基本的な手順を説明します。

ステップ 1: プロジェクトのセットアップ

新しい Laravel プロジェクトを作成します:

composer create-project laravel/laravel task-api
cd task-api
code .

データベースを構成します:
.env ファイルで、データベース構成を設定します。

DB_DATABASE=task_api
DB_USERNAME=your_username
DB_PASSWORD=your_password

タスクテーブルを生成します:
コマンドを実行して、タスク テーブルの新しい移行を作成します:

php artisan make:migration create_tasks_table --create=tasks

移行ファイル (database/migrations/xxxx_xx_xx_create_tasks_table.php) で、テーブル構造を定義します。

<?php use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up(): void
    {
        Schema::create('tasks', function (Blueprint $table) {
            $table->id();
            $table->string('title');
            $table->text('description')->nullable();
            $table->boolean('completed')->default(false);
            $table->timestamps();
        });
    }

    public function down(): void
    {
        Schema::dropIfExists('tasks');
    }
};

移行を実行してテーブルを作成します:

php artisan migrate

ステップ 2: モデルとコントローラーの作成

タスクのモデルとコントローラーを作成します:

php artisan make:model Task
php artisan make:controller TaskController --api

タスク モデルを定義します (app/Models/Task.php):

<?php namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Task extends Model
{
    use HasFactory;

    protected $fillable = ['title', 'description', 'completed'];
}

ステップ 3: API ルートの定義

routes/api.php ファイルに、TaskController のルートを追加します。

<?php use App\Http\Controllers\TaskController;
use Illuminate\Support\Facades\Route;

Route::apiResource('tasks', TaskController::class);

ステップ 4: TaskController での CRUD の実装

TaskController で、基本的な CRUD メソッドを実装します。

<?php namespace App\Http\Controllers;

use App\Models\Task;
use Illuminate\Http\Request;

class TaskController extends Controller
{
    public function index()
    {
        $tasks = Task::all();
        return response()->json($tasks, 200);
    }

    public function store(Request $request)
    {
        $request->validate([
            'title' => 'required|string|max:255',
            'description' => 'nullable|string'
        ]);
        $task = Task::create($request->all());
        return response()->json($task, 201);
    }

    public function show(Task $task)
    {
        return response()->json($task, 200);
    }

    public function update(Request $request, Task $task)
    {
        $request->validate([
            'title' => 'required|string|max:255',
            'description' => 'nullable|string',
            'completed' => 'boolean'
        ]);
        $task->update($request->all());
        return response()->json($task, 201);
    }

    public function destroy(Task $task)
    {
        $task->delete();
        return response()->json(null, 204);
    }
}

ステップ 5: エンドポイントのテスト (VS コード)

次に、REST クライアント (https://marketplace.visualstudio.com/items?itemName=humao.rest-client) と呼ばれる VS Code 拡張機能を使用して、各エンドポイントを手動でテストします。必要に応じて、Insomnia または Postman も使用できます!

拡張機能をインストールした後、次の内容を含む .http ファイルをプロジェクト フォルダーに作成します。

### Create New Task
POST http://127.0.0.1:8000/api/tasks HTTP/1.1
content-type: application/json
Accept: application/json

{
    "title": "Study Laravel"
}

### Show Tasks
GET http://127.0.0.1:8000/api/tasks HTTP/1.1
content-type: application/json
Accept: application/json

### Show Task
GET http://127.0.0.1:8000/api/tasks/1 HTTP/1.1
content-type: application/json
Accept: application/json

### Update Task
PUT http://127.0.0.1:8000/api/tasks/1 HTTP/1.1
content-type: application/json
Accept: application/json

{
    "title": "Study Laravel and Docker",
    "description": "We are studying!",
    "completed": false
}

### Delete Task
DELETE http://127.0.0.1:8000/api/tasks/1 HTTP/1.1
content-type: application/json
Accept: application/json

このファイルを使用すると、REST クライアント 拡張機能を使用して VS Code から直接リクエストを送信できるため、API での各ルートのテストが簡単になります。

ステップ 6: API のテスト

次に、各ルートが期待どおりに動作することを確認するテストを作成しましょう。

まず、タスク モデルのファクトリーを作成します。

php artisan make:factory TaskFactory

<?php namespace Database\Factories;

use Illuminate\Database\Eloquent\Factories\Factory;

class TaskFactory extends Factory
{
    public function definition(): array
    {
        return [
            'title' => fake()->sentence(),
            'description' => fake()->paragraph(),
            'completed' => false,
        ];
    }
}

PHPUnit 構成:

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nonamespaceschemalocation="vendor/phpunit/phpunit/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true">
    <testsuites>
        <testsuite name="Unit">
            <directory>tests/Unit</directory>
        </testsuite>
        <testsuite name="Feature">
            <directory>tests/Feature</directory>
        </testsuite>
    </testsuites>
    <source>
        <include>
            <directory>app</directory>
        </include>
    </source>
    <php>
        <env name="APP_ENV" value="testing"></env>
        <env name="BCRYPT_ROUNDS" value="4"></env>
        <env name="CACHE_DRIVER" value="array"></env>
        <env name="DB_CONNECTION" value="sqlite"></env>
        <env name="DB_DATABASE" value=":memory:"></env>
        <env name="MAIL_MAILER" value="array"></env>
        <env name="PULSE_ENABLED" value="false"></env>
        <env name="QUEUE_CONNECTION" value="sync"></env>
        <env name="SESSION_DRIVER" value="array"></env>
        <env name="TELESCOPE_ENABLED" value="false"></env>
    </php>
</phpunit>

統合テストを作成します:

php artisan make:test TaskApiTest

tests/Feature/TaskApiTest.php ファイルで、次のテストを実装します。

<?php namespace Tests\Feature;

use App\Models\Task;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

class TaskApiTest extends TestCase
{
    use RefreshDatabase;

    public function test_can_create_task(): void
    {
        $response = $this->postJson('/api/tasks', [
            'title' => 'New Task',
            'description' => 'Task Description',
            'completed' => false,
        ]);

        $response->assertStatus(201);

        $response->assertJson([
            'title' => 'New Task',
            'description' => 'Task Description',
            'completed' => false,
        ]);
    }

    public function test_can_list_tasks()
    {
        Task::factory()->count(3)->create();

        $response = $this->getJson('/api/tasks');

        $response->assertStatus(200);

        $response->assertJsonCount(3);
    }

    public function test_can_show_task()
    {
        $task = Task::factory()->create();

        $response = $this->getJson("/api/tasks/{$task->id}");

        $response->assertStatus(200);

        $response->assertJson([
            'title' => $task->title,
            'description' => $task->description,
            'completed' => false,
        ]);
    }

    public function test_can_update_task()
    {
        $task = Task::factory()->create();

        $response = $this->putJson("/api/tasks/{$task->id}", [
            'title' => 'Update Task',
            'description' => 'Update Description',
            'completed' => true,
        ]);

        $response->assertStatus(201);

        $response->assertJson([
            'title' => 'Update Task',
            'description' => 'Update Description',
            'completed' => true,
        ]);
    }

    public function test_can_delete_task()
    {
        $task = Task::factory()->create();

        $response = $this->deleteJson("/api/tasks/{$task->id}");

        $response->assertStatus(204);

        $this->assertDatabaseMissing('tasks', ['id' => $task->id]);
    }
}

テストを実行します:

php artisan test

*ありがとうございます! *

以上がLaravelを使用してREST APIを作成する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。