Route::apiResource()

ルート・エーピーアイ・リソース（ルーティングとコントローラ）

意味 APIリソースルート作成

Route::apiResource()とは？

Route::apiResource()は、LaravelでRESTful APIのためのリソースルートを作成するメソッドです。通常のRoute::resource()と似ていますが、create()とedit()メソッドを除外し、APIに特化した5つのルートのみを生成します。

Route::apiResource()の具体的な使い方

APIリソースルートの定義

Route::apiResource('users', UserController::class);

// UserController.php
class UserController extends Controller
{
    public function index()
    {
        return response()->json(['message' => 'Users index']);
    }

    public function show($id)
    {
        return response()->json(['message' => "Showing user {$id}"]);
    }

    // 他のメソッド...
}

👇出力結果

APIリクエストで/api/usersにGETリクエスト: {"message":"Users index"}
/api/users/1にGETリクエスト: {"message":"Showing user 1"}

この例では、'users'リソースに対して5つのAPI用ルート（index, store, show, update, destroy）が自動的に生成されます。各ルートはUserControllerの対応するメソッドにマッピングされ、JSON形式でレスポンスを返します。

複数のAPIリソースを一度に定義

Route::apiResources([
    'users' => UserController::class,
    'posts' => PostController::class
]);

// PostController.php
class PostController extends Controller
{
    public function index()
    {
        return response()->json(['message' => 'Posts index']);
    }

    // 他のメソッド...
}

👇出力結果

APIリクエストで/api/postsにGETリクエスト: {"message":"Posts index"}

この例では、複数のAPIリソース（usersとposts）を一度に定義しています。これにより、関連する複数のリソースに対するAPIエンドポイントを効率的に設定できます。

Route::apiResource()に関するよくある質問

Q. apiResource()と通常のリソースの違い

A. apiResource()は、APIに特化した5つのルート（index, store, show, update, destroy）のみを生成します。通常のresource()が生成するcreateとeditルートは含まれません。これは、APIではHTMLフォームを表示する必要がないためです。

Q. apiResource()のルートプレフィックス

A. デフォルトでは、apiResource()で生成されるルートに特別なプレフィックスはつきません。APIルートにプレフィックスをつけたい場合は、Route::group()やRouteServiceProviderでプレフィックスを設定する必要があります。

Q. 複数のapiResourceを一度に定義？

A. 複数のAPIリソースを一度に定義するには、Route::apiResources()メソッドを使用できます。例：Route::apiResources(['users' => UserController::class, 'posts' => PostController::class]);

LaravelのRoute::apiResource()についても学べる書籍の紹介

「プログラミング単語帳」を使って、プログラミングの単語を英単語のように学習してみませんか？
プログラミング単語帳には、LaravelのRoute::apiResource()やRoute::get()、Route::middleware()、Route::resource()、などのような実務でよく使われる単語が数百以上収録されています。
この書籍には、プログラミングの単語の意味や読み方、単語の使い方がわかる例文などが掲載されており、いつでもどこでもプログラミングの学習ができます。

よく使われる単語にだけ絞って学習することができるので、効率的にプログラミングが学習できます。