LaravelでAPIを書く方法

Laravel は、人気のある PHP フレームワークとして、開発者が API を作成するための最初の選択肢となっています。 Laravel を使用すると、高品質の API をすばやく作成でき、企業や個人の開発者の間で人気が高まっています。

この記事では、Laravel を使用して API を作成する方法を説明します。 API の構築、API ルーティング、コントローラー、API テストの側面から始めます。

API の構築

API を構築するときは、Laravel が提供する組み込みのミドルウェアとルーターを使用する必要があります。 Laravel 5.5 以降、フレームワークには API リソース コントローラー機能が組み込まれています。この機能により、開発者は標準 REST API をより迅速に作成できるようになり、コードの一貫性を維持するのに役立ちます。

リソース コントローラーを使用するにはどうすればよいですか?まず、コマンドラインで次のコマンドを実行して、新しいコントローラーを作成します。

php artisan make:controller Api/PostController --api

これにより、PostController という名前の API コントローラーが作成され、Laravel の組み込み ## が自動的に継承されます。 #ResourceController には、すべての事前定義されたメソッドが含まれています。これらのメソッドには、インデックス、表示、保存、更新、および破棄が含まれます。

API ルーティング

Laravel では、API リクエストを処理するルーティングの最上位コントローラーを定義する必要があるため、ルーティングはコントローラーと密接に結合されています。

Route::prefix('api')->group(function () {
    Route::resource('posts', 'Api\PostController');
});

このルートは、Post モデルの CRUD 機能を操作するために使用される '/api/posts' の URL を定義します。

コントローラー

リソース コントローラーでは、事前定義された関数を使用して一般的なタスクを処理できます。たとえば、次のコードは投稿記事のアップロード ファイルの作成と添付を開始し、ファイルをリポジトリからパブリック ディレクトリに移動します。

public function store(Request $request)
{
    $path = $request->file('photo')->store('public/photos');
    
    $post = new Post;
    
    $post->title = $request->input('title');
    $post->description = $request->input('description');
    $post->slug = str_slug($request->input('title'));
    $post->photo = $path;
    
    $post->save();
    
    return new Resource($post);
}

API テスト

API のテストは、API が機能が適切に動作しているかどうか。API を作成するときは、必ずテスト ケースを作成してください。 Laravel には、テスト ケースを簡単に作成できるフレームワーク テスト ツールも組み込まれています。

API のテストを作成する場合、HTTP リクエストを送信して応答を確認することで、コントローラーをテストできます。たとえば、次のコードは、コントローラーが投稿のリストを正しく取得できるかどうかをテストします。

public function testPostIndex()
{
    $response = $this->json('GET', '/api/posts');
    
    $response->assertStatus(200);
    $response->assertJsonStructure([
        'data' => [
            '*' => [
                'id',
                'title',
                'description',
                'slug',
                'photo',
                'created_at',
                'updated_at'
            ]
        ]
    ]);
}

結論

Laravel では、API を記述するのは非常に簡単です。事前定義された API コントローラーと組み込みルーターを使用して、標準の REST API を迅速に作成できます。 Laravel のテスト ツールを使用してテスト ケースを作成し、API 機能が適切に動作しているかどうかを確認します。優れたドキュメントとコミュニティサポートが、Laravel を開発者にとって最も人気のあるフレームワークの 1 つにする重要な要素です。

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