基本 - ルーティング（Routing） - 《Laravel 11.x ドキュメント》日本語

基本ルーティング
ルートパラメータ
名前付きルート
- 名前付きルートへのURL生成
- 現在のルートの検査
ルートグループ
ルートモデルバインディング
フォールバックルート
レート制限
- レートリミッターの定義
  - レート制限のセグメンテーション
  - 複数のレート制限
- ルートへのレートリミッターの添付
  - Redisによるスロットリング
フォームメソッドの偽装
現在のルートへのアクセス
クロスオリジンリソース共有 (CORS)
ルートキャッシング

基本ルーティング

最も基本的なLaravelのルートはURIとクロージャを受け入れ、複雑なルーティング設定ファイルなしでルートと動作を定義する非常にシンプルで表現力豊かな方法を提供します：

use Illuminate\Support\Facades\Route;
Route::get('/greeting', function () {
   return 'Hello World';
});

デフォルトのルートファイル

すべてのLaravelのルートは、routesディレクトリにあるルートファイルで定義されています。これらのファイルは、アプリケーションのbootstrap/app.phpファイルに指定された設定を使用してLaravelによって自動的に読み込まれます。routes/web.phpファイルは、Webインターフェース用のルートを定義します。これらのルートには、セッション状態やCSRF保護などの機能を提供するweb ミドルウェアグループが割り当てられています。

ほとんどのアプリケーションでは、routes/web.phpファイルでルートを定義することから始めます。routes/web.phpで定義されたルートには、ブラウザで定義されたルートのURLを入力することでアクセスできます。たとえば、ブラウザでhttp://example.com/userに移動することで、次のルートにアクセスできます：

use App\Http\Controllers\UserController;
Route::get('/user', [UserController::class, 'index']);

APIルート

アプリケーションがステートレスAPIも提供する場合、install:api Artisanコマンドを使用してAPIルーティングを有効にできます：

php artisan install:api

install:apiコマンドは、Laravel Sanctumをインストールし、サードパーティのAPI消費者、SPA、またはモバイルアプリケーションを認証するために使用できる堅牢でシンプルなAPIトークン認証ガードを提供します。さらに、install:apiコマンドはroutes/api.phpファイルを作成します：

Route::get('/user', function (Request $request) {
   return $request->user();
})->middleware('auth:sanctum');

routes/api.phpのルートはステートレスであり、api ミドルウェアグループに割り当てられています。さらに、/api URIプレフィックスはこれらのルートに自動的に適用されるため、ファイル内のすべてのルートに手動で適用する必要はありません。プレフィックスは、アプリケーションのbootstrap/app.phpファイルを変更することで変更できます：

->withRouting(
   api: __DIR__.'/../routes/api.php',
   apiPrefix: 'api/admin',
   // ...
)

利用可能なルーターメソッド

ルーターは、任意のHTTP動詞に応答するルートを登録することを許可します：

Route::get($uri, $callback);
Route::post($uri, $callback);
Route::put($uri, $callback);
Route::patch($uri, $callback);
Route::delete($uri, $callback);
Route::options($uri, $callback);

時には、複数のHTTP動詞に応答するルートを登録する必要があるかもしれません。その場合は、matchメソッドを使用できます。また、anyメソッドを使用して、すべてのHTTP動詞に応答するルートを登録することもできます：

Route::match(['get', 'post'], '/', function () {
   // ...
});
Route::any('/', function () {
   // ...
});

同じURIを共有する複数のルートを定義する場合、get、post、put、patch、delete、およびoptionsメソッドを使用するルートは、any、match、およびredirectメソッドを使用するルートの前に定義する必要があります。これにより、受信リクエストが正しいルートに一致することが保証されます。

依存性注入

ルートのコールバックシグネチャ内で、ルートに必要な依存関係を型ヒントすることができます。宣言された依存関係は、Laravelのサービスコンテナによって自動的に解決され、コールバックに注入されます。たとえば、Illuminate\Http\Requestクラスを型ヒントすることで、現在のHTTPリクエストが自動的にルートコールバックに注入されます：

use Illuminate\Http\Request;
Route::get('/users', function (Request $request) {
   // ...
});

CSRF保護


``````php
<form method="POST" action="/profile">
   @csrf
   ...
</form>
`

リダイレクトルート

別のURIにリダイレクトするルートを定義する場合、Route::redirectメソッドを使用できます。このメソッドは、単純なリダイレクトを実行するために完全なルートやコントローラーを定義する必要がない便利なショートカットを提供します：

Route::redirect('/here', '/there');

デフォルトでは、Route::redirectは302ステータスコードを返します。オプションの3番目のパラメータを使用してステータスコードをカスタマイズできます：

Route::redirect('/here', '/there', 301);

また、Route::permanentRedirectメソッドを使用して301ステータスコードを返すこともできます：

Route::permanentRedirect('/here', '/there');

リダイレクトルートでルートパラメータを使用する場合、次のパラメータはLaravelによって予約されており、使用できません：destinationおよびstatus。

ビューのルート

ルートがビューを返すだけでよい場合、Route::viewメソッドを使用できます。redirectメソッドと同様に、このメソッドは完全なルートやコントローラーを定義する必要がないシンプルなショートカットを提供します。viewメソッドは、最初の引数としてURIを、2番目の引数としてビュー名を受け取ります。さらに、オプションの3番目の引数としてビューに渡すデータの配列を提供できます：

Route::view('/welcome', 'welcome');
Route::view('/welcome', 'welcome', ['name' => 'Taylor']);

ビューのルートでルートパラメータを使用する場合、次のパラメータはLaravelによって予約されており、使用できません：view、data、status、およびheaders。

ルートの一覧表示

route:list Artisanコマンドを使用すると、アプリケーションによって定義されたすべてのルートの概要を簡単に提供できます：

php artisan route:list

デフォルトでは、各ルートに割り当てられたルートミドルウェアはroute:list出力に表示されません。ただし、-vオプションをコマンドに追加することで、Laravelにルートミドルウェアとミドルウェアグループ名を表示させることができます：

php artisan route:list -v
# ミドルウェアグループの展開...
php artisan route:list -vv

特定のURIで始まるルートのみを表示するようにLaravelに指示することもできます：

php artisan route:list --path=api

さらに、--except-vendorオプションを提供することで、サードパーティパッケージによって定義されたルートを非表示にするようにLaravelに指示できます。route:listコマンドを実行するとき：

php artisan route:list --except-vendor

同様に、--only-vendorオプションを提供することで、サードパーティパッケージによって定義されたルートのみを表示するようにLaravelに指示できます。route:listコマンドを実行するとき：

php artisan route:list --only-vendor

ルーティングのカスタマイズ

デフォルトでは、アプリケーションのルートはbootstrap/app.phpファイルによって構成され、読み込まれます：

<?php
use Illuminate\Foundation\Application;
return Application::configure(basePath: dirname(__DIR__))
   ->withRouting(
   web: __DIR__.'/../routes/web.php',
   commands: __DIR__.'/../routes/console.php',
   health: '/up',
   )->create();

ただし、時にはアプリケーションのルートのサブセットを含むまったく新しいファイルを定義したい場合があります。これを実現するには、thenクロージャをwithRoutingメソッドに提供できます。このクロージャ内で、アプリケーションに必要な追加のルートを登録できます：

use Illuminate\Support\Facades\Route;
->withRouting(
   web: __DIR__.'/../routes/web.php',
   commands: __DIR__.'/../routes/console.php',
   health: '/up',
   then: function () {
   Route::middleware('api')
   ->prefix('webhooks')
   ->name('webhooks.')
   ->group(base_path('routes/webhooks.php'));
   },
)

また、usingクロージャをwithRoutingメソッドに提供することで、ルート登録を完全に制御することもできます。この引数が渡されると、フレームワークによってHTTPルートは登録されず、すべてのルートを手動で登録する責任があります：

use Illuminate\Support\Facades\Route;
->withRouting(
   commands: __DIR__.'/../routes/console.php',
   using: function () {
   Route::middleware('api')
   ->prefix('api')
   ->group(base_path('routes/api.php'));
   Route::middleware('web')
   ->group(base_path('routes/web.php'));
   },
)

ルートパラメータ

必須パラメータ

時には、ルート内でURIのセグメントをキャプチャする必要があります。たとえば、URLからユーザーのIDをキャプチャする必要があるかもしれません。その場合は、ルートパラメータを定義することで実現できます：

Route::get('/user/{id}', function (string $id) {
   return 'User '.$id;
});

ルートに必要な数だけルートパラメータを定義できます：

Route::get('/posts/{post}/comments/{comment}', function (string $postId, string $commentId) {
   // ...
});

ルートパラメータは常に{}ブレース内に囲まれ、アルファベット文字で構成される必要があります。アンダースコア（_）もルートパラメータ名内で許可されます。ルートパラメータは、その順序に基づいてルートコールバック/コントローラーに注入されます - ルートコールバック/コントローラー引数の名前は重要ではありません。

パラメータと依存性注入

ルートに依存関係があり、Laravelのサービスコンテナが自動的にルートのコールバックに注入することを希望する場合、依存関係の後にルートパラメータをリストする必要があります：

use Illuminate\Http\Request;
Route::get('/user/{id}', function (Request $request, string $id) {
   return 'User '.$id;
});

オプションのパラメータ

時には、URIに常に存在しない可能性のあるルートパラメータを指定する必要があります。その場合は、パラメータ名の後に?マークを置くことで実現できます。ルートの対応する変数にデフォルト値を設定することを忘れないでください：

Route::get('/user/{name?}', function (?string $name = null) {
   return $name;
});
Route::get('/user/{name?}', function (?string $name = 'John') {
   return $name;
});

正規表現制約

ルートインスタンスのwhereメソッドを使用して、ルートパラメータの形式を制約できます。whereメソッドは、パラメータの名前と、パラメータが制約される方法を定義する正規表現を受け取ります：

Route::get('/user/{name}', function (string $name) {
   // ...
})->where('name', '[A-Za-z]+');
Route::get('/user/{id}', function (string $id) {
   // ...
})->where('id', '[0-9]+');
Route::get('/user/{id}/{name}', function (string $id, string $name) {
   // ...
})->where(['id' => '[0-9]+', 'name' => '[a-z]+']);

便利なことに、一般的に使用される正規表現パターンには、ルートにパターン制約を迅速に追加できるヘルパーメソッドがあります：

Route::get('/user/{id}/{name}', function (string $id, string $name) {
   // ...
})->whereNumber('id')->whereAlpha('name');
Route::get('/user/{name}', function (string $name) {
   // ...
})->whereAlphaNumeric('name');
Route::get('/user/{id}', function (string $id) {
   // ...
})->whereUuid('id');
Route::get('/user/{id}', function (string $id) {
   // ...
})->whereUlid('id');
Route::get('/category/{category}', function (string $category) {
   // ...
})->whereIn('category', ['movie', 'song', 'painting']);
Route::get('/category/{category}', function (string $category) {
   // ...
})->whereIn('category', CategoryEnum::cases());

受信リクエストがルートパターン制約に一致しない場合、404 HTTPレスポンスが返されます。

グローバル制約

ルートパラメータが常に特定の正規表現によって制約されるようにしたい場合、patternメソッドを使用できます。これらのパターンは、アプリケーションのApp\Providers\AppServiceProviderクラスのbootメソッドで定義する必要があります：

use Illuminate\Support\Facades\Route;
/**
 * Bootstrap any application services.
 */
public function boot(): void
{
   Route::pattern('id', '[0-9]+');
}

パターンが定義されると、それは自動的にそのパラメータ名を使用するすべてのルートに適用されます：

Route::get('/user/{id}', function (string $id) {
   // Only executed if {id} is numeric...
});

エンコードされたフォワードスラッシュ

Laravelのルーティングコンポーネントは、ルートパラメータの値内に/以外のすべての文字を含むことを許可します。プレースホルダーの一部として/を明示的に許可する必要があります。where条件の正規表現を使用します：

Route::get('/search/{search}', function (string $search) {
   return $search;
})->where('search', '.*');

エンコードされたフォワードスラッシュは、最後のルートセグメント内でのみサポートされます。

名前付きルート

名前付きルートは、特定のルートのURLやリダイレクトを便利に生成することを可能にします。ルート定義にnameメソッドをチェーンすることで、ルートに名前を指定できます：

Route::get('/user/profile', function () {
   // ...
})->name('profile');

コントローラーアクションのルート名を指定することもできます：

Route::get(
   '/user/profile',
   [UserProfileController::class, 'show']
)->name('profile');

ルート名は常に一意である必要があります。

名前付きルートへのURL生成

特定のルートに名前を付けたら、Laravelのrouteおよびredirectヘルパー関数を使用してURLやリダイレクトを生成する際にそのルートの名前を使用できます：

// Generating URLs...
$url = route('profile');
// Generating Redirects...
return redirect()->route('profile');
return to_route('profile');

名前付きルートがパラメータを定義している場合、route関数の2番目の引数としてパラメータを渡すことができます。指定されたパラメータは、生成されたURLの正しい位置に自動的に挿入されます：

Route::get('/user/{id}/profile', function (string $id) {
   // ...
})->name('profile');
$url = route('profile', ['id' => 1]);

配列に追加のパラメータを渡すと、それらのキー/値ペアは生成されたURLのクエリ文字列に自動的に追加されます：

Route::get('/user/{id}/profile', function (string $id) {
   // ...
})->name('profile');
$url = route('profile', ['id' => 1, 'photos' => 'yes']);
// /user/1/profile?photos=yes

時には、現在のロケールなどのURLパラメータのリクエスト全体に対するデフォルト値を指定したい場合があります。これを実現するには、URL::defaultsメソッドを使用できます。

現在のルートの検査

現在のリクエストが特定の名前付きルートにルーティングされたかどうかを判断したい場合、ルートインスタンスのnamedメソッドを使用できます。たとえば、ルートミドルウェアから現在のルート名を確認できます：

use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;
/**
 * Handle an incoming request.
 *
 * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
 */
public function handle(Request $request, Closure $next): Response
{
   if ($request->route()->named('profile')) {
   // ...
   }
   return $next($request);
}

ルートグループ

ルートグループを使用すると、多くのルートにわたってミドルウェアなどのルート属性を共有できます。各個別のルートでそれらの属性を定義する必要はありません。

ネストされたグループは、親グループと属性を「マージ」しようとします。ミドルウェアとwhere条件はマージされ、名前とプレフィックスは追加されます。名前空間の区切り文字とURIプレフィックス内のスラッシュは、適切な場所に自動的に追加されます。

ミドルウェア

ミドルウェアをグループ内のすべてのルートに割り当てるには、グループを定義する前にmiddlewareメソッドを使用できます。ミドルウェアは、配列にリストされた順序で実行されます：

Route::middleware(['first', 'second'])->group(function () {
   Route::get('/', function () {
   // Uses first & second middleware...
   });
   Route::get('/user/profile', function () {
   // Uses first & second middleware...
   });
});

コントローラー

ルートのグループがすべて同じコントローラーを利用する場合、controllerメソッドを使用して、グループ内のすべてのルートの共通コントローラーを定義できます。次に、ルートを定義する際には、呼び出すコントローラーメソッドを指定するだけで済みます：

use App\Http\Controllers\OrderController;
Route::controller(OrderController::class)->group(function () {
   Route::get('/orders/{id}', 'show');
   Route::post('/orders', 'store');
});

サブドメインルーティング

ルートグループは、サブドメインルーティングを処理するためにも使用できます。サブドメインは、ルートURIと同様にルートパラメータを割り当てることができ、ルートやコントローラーで使用するためにサブドメインの一部をキャプチャできます。サブドメインは、グループを定義する前にdomainメソッドを呼び出すことで指定できます：

Route::domain('{account}.example.com')->group(function () {
   Route::get('/user/{id}', function (string $account, string $id) {
   // ...
   });
});

サブドメインルートが到達可能であることを確認するために、ルートドメインルートを登録する前にサブドメインルートを登録する必要があります。これにより、同じURIパスを持つルートドメインルートがサブドメインルートを上書きするのを防ぎます。

ルートプレフィックス


``````php
Route::prefix('admin')->group(function () {
   Route::get('/users', function () {
   // Matches The "/admin/users" URL
   });
});
`

ルート名プレフィックス


``````php
Route::name('admin.')->group(function () {
   Route::get('/users', function () {
   // Route assigned name "admin.users"...
   })->name('users');
});
`

ルートモデルバインディング

ルートまたはコントローラーアクションにモデルIDを注入する場合、そのIDに対応するモデルを取得するためにデータベースをクエリすることがよくあります。Laravelのルートモデルバインディングは、モデルインスタンスをルートに直接自動的に注入する便利な方法を提供します。たとえば、ユーザーのIDを注入する代わりに、指定されたIDに一致するUserモデルインスタンス全体を注入できます。

暗黙のバインディング

Laravelは、型ヒントされた変数名がルートセグメント名と一致するルートまたはコントローラーアクションで定義されたEloquentモデルを自動的に解決します。たとえば：

use App\Models\User;
Route::get('/users/{user}', function (User $user) {
   return $user->email;
});

$user変数がApp\Models\User Eloquentモデルとして型ヒントされ、変数名が{user} URIセグメントと一致するため、Laravelは自動的にリクエストURIから対応する値に一致するIDを持つモデルインスタンスを注入します。データベースに一致するモデルインスタンスが見つからない場合、404 HTTPレスポンスが自動的に生成されます。

もちろん、コントローラーメソッドを使用する場合も暗黙のバインディングは可能です。再度、{user} URIセグメントが$user変数と一致し、App\Models\User型ヒントを含むコントローラー内で：

use App\Http\Controllers\UserController;
use App\Models\User;
// Route definition...
Route::get('/users/{user}', [UserController::class, 'show']);
// Controller method definition...
public function show(User $user)
{
   return view('user.profile', ['user' => $user]);
}

ソフト削除されたモデル

通常、暗黙のモデルバインディングはソフト削除されたモデルを取得しません。ただし、ルートの定義にwithTrashedメソッドをチェーンすることで、暗黙のバインディングにこれらのモデルを取得させることができます：

use App\Models\User;
Route::get('/users/{user}', function (User $user) {
   return $user->email;
})->withTrashed();

キーのカスタマイズ

時には、id以外の列を使用してEloquentモデルを解決したい場合があります。その場合は、ルートパラメータ定義で列を指定できます：

use App\Models\Post;
Route::get('/posts/{post:slug}', function (Post $post) {
   return $post;
});

特定のモデルクラスを取得する際に、常にid以外のデータベース列を使用するようにモデルバインディングを設定したい場合は、EloquentモデルのgetRouteKeyNameメソッドをオーバーライドできます：

/**
 * Get the route key for the model.
 */
public function getRouteKeyName(): string
{
   return 'slug';
}

カスタムキーとスコーピング

単一のルート定義で複数のEloquentモデルを暗黙的にバインディングする場合、前のEloquentモデルの子である必要があるように2番目のEloquentモデルをスコープしたい場合があります。たとえば、特定のユーザーのスラッグによってブログ投稿を取得するこのルート定義を考えてみてください：

use App\Models\Post;
use App\Models\User;
Route::get('/users/{user}/posts/{post:slug}', function (User $user, Post $post) {
   return $post;
});

カスタムキーの暗黙のバインディングをネストされたルートパラメータとして使用する場合、Laravelは自動的に親の関係名を推測するための慣例を使用して、ネストされたモデルを親によって取得するためのクエリをスコープします。この場合、Userモデルには、posts（ルートパラメータ名の複数形）という名前の関係があると仮定されます。Postモデルを取得するために使用できます。

必要に応じて、カスタムキーが提供されていない場合でも、Laravelに「子」バインディングをスコープするように指示できます。これを実現するには、ルートを定義する際にscopeBindingsメソッドを呼び出すことができます：

use App\Models\Post;
use App\Models\User;
Route::get('/users/{user}/posts/{post}', function (User $user, Post $post) {
   return $post;
})->scopeBindings();

また、ルート定義のグループ全体にスコープバインディングを使用するように指示できます：

Route::scopeBindings()->group(function () {
   Route::get('/users/{user}/posts/{post}', function (User $user, Post $post) {
   return $post;
   });
});

同様に、withoutScopedBindingsメソッドを呼び出すことで、バインディングをスコープしないようにLaravelに明示的に指示できます：

Route::get('/users/{user}/posts/{post:slug}', function (User $user, Post $post) {
   return $post;
})->withoutScopedBindings();

見つからないモデルの動作のカスタマイズ

通常、暗黙的にバインディングされたモデルが見つからない場合、404 HTTPレスポンスが生成されます。ただし、ルートを定義する際にmissingメソッドを呼び出すことで、この動作をカスタマイズできます。missingメソッドは、暗黙的にバインディングされたモデルが見つからない場合に呼び出されるクロージャを受け取ります：

use App\Http\Controllers\LocationsController;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Redirect;
Route::get('/locations/{location:slug}', [LocationsController::class, 'show'])
   ->name('locations.view')
   ->missing(function (Request $request) {
   return Redirect::route('locations.index');
   });

暗黙のEnumバインディング

PHP 8.1はEnumsのサポートを導入しました。この機能を補完するために、Laravelはルート定義でバックエンドEnumを型ヒントすることを許可し、そのルートセグメントが有効なEnum値に対応する場合にのみルートを呼び出します。そうでない場合、404 HTTPレスポンスが自動的に返されます。たとえば、次のEnumを考えてみてください：

<?php
namespace App\Enums;
enum Category: string
{
   case Fruits = 'fruits';
   case People = 'people';
}

{category}ルートセグメントがfruitsまたはpeopleの場合にのみ呼び出されるルートを定義できます。そうでない場合、Laravelは404 HTTPレスポンスを返します：

use App\Enums\Category;
use Illuminate\Support\Facades\Route;
Route::get('/categories/{category}', function (Category $category) {
   return $category->value;
});

明示的バインディング

モデルバインディングを使用するために、Laravelの暗黙的な慣習に基づくモデル解決を使用する必要はありません。ルートパラメータがモデルにどのように対応するかを明示的に定義することもできます。明示的なバインディングを登録するには、ルーターのmodelメソッドを使用して、特定のパラメータのクラスを指定します。bootクラスのAppServiceProviderメソッドの最初に明示的なモデルバインディングを定義する必要があります：

use App\Models\User;
use Illuminate\Support\Facades\Route;
/**
 * Bootstrap any application services.
 */
public function boot(): void
{
   Route::model('user', User::class);
}

次に、{user}パラメータを含むルートを定義します：

use App\Models\User;
Route::get('/users/{user}', function (User $user) {
   // ...
});

すべての{user}パラメータがApp\Models\Userモデルにバインドされているため、そのクラスのインスタンスがルートに注入されます。たとえば、users/1へのリクエストは、IDが1のデータベースからUserインスタンスを注入します。

データベースに一致するモデルインスタンスが見つからない場合、404 HTTPレスポンスが自動的に生成されます。

解決ロジックのカスタマイズ

独自のモデルバインディング解決ロジックを定義したい場合、Route::bindメソッドを使用できます。bindメソッドに渡すクロージャは、URIセグメントの値を受け取り、ルートに注入されるべきクラスのインスタンスを返す必要があります。このカスタマイズは、アプリケーションのAppServiceProviderメソッド内で行う必要があります：

use App\Models\User;
use Illuminate\Support\Facades\Route;
/**
 * Bootstrap any application services.
 */
public function boot(): void
{
   Route::bind('user', function (string $value) {
   return User::where('name', $value)->firstOrFail();
   });
}

または、EloquentモデルのresolveRouteBindingメソッドをオーバーライドすることもできます。このメソッドは、URIセグメントの値を受け取り、ルートに注入されるべきクラスのインスタンスを返す必要があります：

/**
 * Retrieve the model for a bound value.
 *
 * @param  mixed  $value
 * @param  string|null  $field
 * @return \Illuminate\Database\Eloquent\Model|null
 */
public function resolveRouteBinding($value, $field = null)
{
   return $this->where('name', $value)->firstOrFail();
}

ルートが暗黙のバインディングスコーピングを利用している場合、resolveChildRouteBindingメソッドは親モデルの子バインディングを解決するために使用されます：

/**
 * Retrieve the child model for a bound value.
 *
 * @param  string  $childType
 * @param  mixed  $value
 * @param  string|null  $field
 * @return \Illuminate\Database\Eloquent\Model|null
 */
public function resolveChildRouteBinding($childType, $value, $field)
{
   return parent::resolveChildRouteBinding($childType, $value, $field);
}

フォールバックルート


``````php
Route::fallback(function () {
   // ...
});
`

フォールバックルートは、アプリケーションによって登録される最後のルートである必要があります。

レート制限

レートリミッターの定義

Laravelには、特定のルートまたはルートグループのトラフィック量を制限するために利用できる強力でカスタマイズ可能なレート制限サービスが含まれています。始めるには、アプリケーションのニーズに合ったレートリミッターの設定を定義する必要があります。

レートリミッターは、アプリケーションのApp\Providers\AppServiceProviderクラスのbootメソッド内で定義できます：

use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\RateLimiter;
/**
 * Bootstrap any application services.
 */
protected function boot(): void
{
   RateLimiter::for('api', function (Request $request) {
   return Limit::perMinute(60)->by($request->user()?->id ?: $request->ip());
   });
}

レートリミッターは、RateLimiterファサードのforメソッドを使用して定義されます。forメソッドは、レートリミッター名と、レートリミッターに割り当てられるルートに適用される制限設定を返すクロージャを受け取ります。制限設定は、Illuminate\Cache\RateLimiting\Limitクラスのインスタンスです。このクラスには、制限を迅速に定義できる便利な「ビルダー」メソッドが含まれています。レートリミッター名は、任意の文字列を使用できます：

use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\RateLimiter;
/**
 * Bootstrap any application services.
 */
protected function boot(): void
{
   RateLimiter::for('global', function (Request $request) {
   return Limit::perMinute(1000);
   });
}

受信リクエストが指定されたレート制限を超えた場合、Laravelによって429 HTTPステータスコードのレスポンスが自動的に返されます。レート制限によって返されるレスポンスを定義したい場合は、responseメソッドを使用できます：

RateLimiter::for('global', function (Request $request) {
   return Limit::perMinute(1000)->response(function (Request $request, array $headers) {
   return response('Custom response...', 429, $headers);
   });
});

レートリミッターコールバックは受信HTTPリクエストインスタンスを受け取るため、受信リクエストや認証されたユーザーに基づいて適切なレート制限を動的に構築できます：

RateLimiter::for('uploads', function (Request $request) {
   return $request->user()->vipCustomer()
   ? Limit::none()
   : Limit::perMinute(100);
});

レート制限のセグメンテーション

時には、任意の値によってレート制限をセグメント化したい場合があります。たとえば、ユーザーが特定のルートに対してIPアドレスごとに1分間に100回アクセスできるようにしたい場合があります。これを実現するには、レート制限を構築する際にbyメソッドを使用できます：

RateLimiter::for('uploads', function (Request $request) {
   return $request->user()->vipCustomer()
   ? Limit::none()
   : Limit::perMinute(100)->by($request->ip());
});

この機能を別の例で示すと、認証されたユーザーIDごとに1分間に100回、またはゲストの場合はIPアドレスごとに1分間に10回のアクセスを制限できます：

RateLimiter::for('uploads', function (Request $request) {
   return $request->user()
   ? Limit::perMinute(100)->by($request->user()->id)
   : Limit::perMinute(10)->by($request->ip());
});

複数のレート制限

必要に応じて、特定のレートリミッター設定に対してレート制限の配列を返すことができます。各レート制限は、配列内に配置された順序に基づいてルートに対して評価されます：

RateLimiter::for('login', function (Request $request) {
   return [
   Limit::perMinute(500),
   Limit::perMinute(3)->by($request->input('email')),
   ];
});

ルートへのレートリミッターの添付

レートリミッターは、throttle ミドルウェアを使用してルートまたはルートグループに添付できます。スロットルミドルウェアは、ルートに割り当てたいレートリミッターの名前を受け取ります：

Route::middleware(['throttle:uploads'])->group(function () {
   Route::post('/audio', function () {
   // ...
   });
   Route::post('/video', function () {
   // ...
   });
});

Redisによるスロットリング

デフォルトでは、throttleミドルウェアはIlluminate\Routing\Middleware\ThrottleRequestsクラスにマッピングされています。ただし、アプリケーションのキャッシュドライバーとしてRedisを使用している場合、LaravelにRedisを使用してレート制限を管理するように指示したい場合があります。これを実現するには、アプリケーションのbootstrap/app.phpファイル内でthrottleWithRedisメソッドを使用する必要があります。このメソッドは、throttleミドルウェアをIlluminate\Routing\Middleware\ThrottleRequestsWithRedisミドルウェアクラスにマッピングします：

->withMiddleware(function (Middleware $middleware) {
   $middleware->throttleWithRedis();
   // ...
})

フォームメソッドの偽装

HTMLフォームは、PUT、PATCH、またはDELETEアクションをサポートしていません。したがって、HTMLフォームから呼び出されるPUT、PATCH、またはDELETEルートを定義する場合、フォームに隠し_methodフィールドを追加する必要があります。_methodフィールドで送信される値は、HTTPリクエストメソッドとして使用されます：

<form action="/example" method="POST">
   <input type="hidden" name="_method" value="PUT">
   <input type="hidden" name="_token" value="{{ csrf_token() }}">
</form>

便利なことに、@method Bladeディレクティブを使用して_method入力フィールドを生成できます：

<form action="/example" method="POST">
   @method('PUT')
   @csrf
</form>

現在のルートへのアクセス


``````php
use Illuminate\Support\Facades\Route;
$route = Route::current(); // Illuminate\Routing\Route
$name = Route::currentRouteName(); // string
$action = Route::currentRouteAction(); // string
`

ルーターおよびルートクラスで利用可能なすべてのメソッドを確認するには、Routeファサードの基礎クラスおよびRouteインスタンスのAPIドキュメントを参照してください。

クロスオリジンリソース共有 (CORS)

Laravelは、設定した値でCORS OPTIONS HTTPリクエストに自動的に応答できます。OPTIONSリクエストは、アプリケーションのグローバルミドルウェアスタックに自動的に含まれるHandleCors ミドルウェアによって自動的に処理されます。

時には、アプリケーションのCORS設定値をカスタマイズする必要があるかもしれません。その場合は、config:publish Artisanコマンドを使用してcors設定ファイルを公開できます：

php artisan config:publish cors

このコマンドは、アプリケーションのconfigディレクトリ内にcors.php設定ファイルを配置します。

CORSおよびCORSヘッダーに関する詳細は、MDNウェブドキュメントのCORSを参照してください。

ルートキャッシング

アプリケーションを本番環境にデプロイする際は、Laravelのルートキャッシュを活用する必要があります。ルートキャッシュを使用すると、アプリケーションのすべてのルートを登録するのにかかる時間が大幅に短縮されます。ルートキャッシュを生成するには、route:cache Artisanコマンドを実行します：

php artisan route:cache

このコマンドを実行した後、キャッシュされたルートファイルはすべてのリクエストで読み込まれます。新しいルートを追加した場合は、新しいルートキャッシュを生成する必要があります。このため、プロジェクトのデプロイ中にのみroute:cacheコマンドを実行する必要があります。


``````shell
php artisan route:clear
`