基本的なルーティングBasic Routing
一番基本のLaravelルートはURIと「クロージャ」により定義され、単純で記述しやすいルートの定義方法を提供しています。The most basic Laravel routes accept a URI and a Closure
, providing a very simple and expressive method of defining routes:
Route::get('foo', function () {
return 'Hello World';
});
デフォルトルート定義ファイルThe Default Route Files
Laravelの全ルートは、routes
ディレクトリ下に設置されている、ルートファイルで定義されます。これらのファイルはフレームワークにより、自動的に読み込まれます。routes/web.php
ファイルで、Webインターフェイスのルートを定義します。定義されたルートはweb
ミドルウェアグループにアサインされ、セッション状態やCSRF保護などの機能が提供されます。routes/api.php
中のルートはステートレスで、api
ミドルウェアグループにアサインされます。All Laravel routes are defined in your route files, which are located in the routes
directory. These files are automatically loaded by the framework. The routes/web.php
file defines routes that are for your web interface. These routes are assigned the web
middleware group, which provides features like session state and CSRF protection. The routes in routes/api.php
are stateless and are assigned the api
middleware group.
ほとんどのアプリケーションでは、routes/web.php
ファイルからルート定義を始めます。routes/web.php
中で定義されたルートは、ブラウザで定義したルートのURLを入力することでアクセスします。たとえば、次のルートはブラウザからhttp://your-app.test/user
でアクセスします。For most applications, you will begin by defining routes in your routes/web.php
file. The routes defined in routes/web.php
may be accessed by entering the defined route's URL in your browser. For example, you may access the following route by navigating to http://your-app.test/user
in your browser:
Route::get('/user', 'UserController@index');
routes/api.php
ファイル中で定義したルートはRouteServiceProvider
により、ルートグループの中にネストされます。このグループには、/api
のURIが自動的にプレフィックスされ、それによりこのファイル中の全ルートにわざわざ指定する必要はありません。プレフィックスや他のルートグループオプションに変更する場合は、RouteServiceProvider
を変更してください。Routes defined in the routes/api.php
file are nested within a route group by the RouteServiceProvider
. Within this group, the /api
URI prefix is automatically applied so you do not need to manually apply it to every route in the file. You may modify the prefix and other route group options by modifying your RouteServiceProvider
class.
使用可能なルート定義メソッドAvailable Router Methods
ルータはHTTP動詞に対応してルートを定義できるようにしています。The router allows you to register routes that respond to any HTTP verb:
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
メソッドが利用できます。もしくは全HTTP動詞に対応するany
メソッドを使い、ルート登録することもできます。Sometimes you may need to register a route that responds to multiple HTTP verbs. You may do so using the match
method. Or, you may even register a route that responds to all HTTP verbs using the any
method:
Route::match(['get', 'post'], '/', function () {
//
});
Route::any('/', function () {
//
});
CSRF保護CSRF Protection
web
ルートファイル中で定義され、POST
、PUT
、PATCH
、DELETE
ルートへ送信されるHTMLフォームはすべて、CSRFトークンフィールドを含んでいる必要があります。含めていないと、そのリクエストは拒否されます。CSRF保護についての詳細は、CSRFのドキュメントをご覧ください。Any HTML forms pointing to POST
, PUT
, PATCH
, or DELETE
routes that are defined in the web
routes file should include a CSRF token field. Otherwise, the request will be rejected. You can read more about CSRF protection in the CSRF documentation[/docs/{{version}}/csrf]:
<form method="POST" action="/profile">
@csrf
...
</form>
リダイレクトルートRedirect Routes
他のURIへリダイレクトするルートを定義する場合は、Route::redirect
メソッドを使用します。このメソッドは便利な短縮形を提供しているので、単純なリダイレクトを実行するために、完全なルートやコントローラを定義する必要はありません。If you are defining a route that redirects to another URI, you may use the Route::redirect
method. This method provides a convenient shortcut so that you do not have to define a full route or controller for performing a simple redirect:
Route::redirect('/here', '/there');
Route::redirect
はデフォルトで、302
ステータスコードを返します。オプションの第3引数を利用し、ステータスコードをカスタマイズできます。By default, Route::redirect
returns a 302
status code. You may customize the status code using the optional third parameter:
Route::redirect('/here', '/there', 301);
Route::permanentRedirect
メソッドを使えば、301
ステータスコードが返されます。You may use the Route::permanentRedirect
method to return a 301
status code:
Route::permanentRedirect('/here', '/there');
ビュールートView Routes
ルートからビューを返すだけの場合は、Route::view
メソッドを使用します。redirect
メソッドと同様に、このメソッドはシンプルな短縮形を提供しており、完全なルートやコントローラを定義する必要はありません。view
メソッドは、最初の引数にURIを取り、ビュー名は第2引数です。さらに、オプションの第3引数として、ビューへ渡すデータの配列を指定することもできます。If your route only needs to return a view, you may use the Route::view
method. Like the redirect
method, this method provides a simple shortcut so that you do not have to define a full route or controller. The view
method accepts a URI as its first argument and a view name as its second argument. In addition, you may provide an array of data to pass to the view as an optional third argument:
Route::view('/welcome', 'welcome');
Route::view('/welcome', 'welcome', ['name' => 'Taylor']);
ルートパラメーターRoute Parameters
必須パラメータRequired Parameters
ルートの中のURIセグメントを取り出す必要が起きることもあります。たとえば、URLからユーザーIDを取り出したい場合です。ルートパラメーターを定義してください。Sometimes you will need to capture segments of the URI within your route. For example, you may need to capture a user's ID from the URL. You may do so by defining route parameters:
Route::get('user/{id}', function ($id) {
return 'User '.$id;
});
ルートで必要なだけ、ルートパラメーターを定義できます。You may define as many route parameters as required by your route:
Route::get('posts/{post}/comments/{comment}', function ($postId, $commentId) {
//
});
ルートパラメータは、いつも{}
括弧で囲み、アルファベット文字で構成してください。ルートパラメータには、ハイフン(-
)を使えません。下線(_
)を代わりに使用してください。ルートパラメータは、ルートコールバック/コントローラへ順番通りに注入されます。コールバック/コントローラ引数の名前は考慮されません。Route parameters are always encased within {}
braces and should consist of alphabetic characters, and may not contain a -
character. Instead of using the -
character, use an underscore (_
). Route parameters are injected into route callbacks / controllers based on their order - the names of the callback / controller arguments do not matter.
任意パラメータOptional Parameters
ルートパラメータを指定してもらう必要があるが、指定は任意にしたいこともよく起こります。パラメータ名の後に?
を付けると、任意指定のパラメータになります。対応するルートの引数に、デフォルト値を必ず付けてください。Occasionally you may need to specify a route parameter, but make the presence of that route parameter optional. You may do so by placing a ?
mark after the parameter name. Make sure to give the route's corresponding variable a default value:
Route::get('user/{name?}', function ($name = null) {
return $name;
});
Route::get('user/{name?}', function ($name = 'John') {
return $name;
});
正規表現制約Regular Expression Constraints
ルートインスタンスのwhere
メソッドを使用し、ルートパラメータのフォーマットを制約できます。where
メソッドはパラメータ名と、そのパラメータがどのように制約を受けるのかを定義する正規表現を引数に取ります。You may constrain the format of your route parameters using the where
method on a route instance. The where
method accepts the name of the parameter and a regular expression defining how the parameter should be constrained:
Route::get('user/{name}', function ($name) {
//
})->where('name', '[A-Za-z]+');
Route::get('user/{id}', function ($id) {
//
})->where('id', '[0-9]+');
Route::get('user/{id}/{name}', function ($id, $name) {
//
})->where(['id' => '[0-9]+', 'name' => '[a-z]+']);
グローバル制約Global Constraints
指定した正規表現でいつもルートパラメータを制約したい場合は、pattern
メソッドを使ってください。RouteServiceProvider
のboot
メソッドの中で、このようなパターンを定義します。If you would like a route parameter to always be constrained by a given regular expression, you may use the pattern
method. You should define these patterns in the boot
method of your RouteServiceProvider
:
/**
* ルートモデル結合、パターンフィルタなどの定義
*
* @return void
*/
public function boot()
{
Route::pattern('id', '[0-9]+');
parent::boot();
}
パターンを定義すると、パラメータ名を使用している全ルートで、自動的に提供されます。Once the pattern has been defined, it is automatically applied to all routes using that parameter name:
Route::get('user/{id}', function ($id) {
// {id}が数値の場合のみ実行される
});
スラッシュのエンコードEncoded Forward Slashes
Laravelのルーティングコンポーネントは、/
を除くすべての文字を許可しています。プレースホルダの一部として、明確に/
を許可する場合は、where
で正規表現の条件を指定します。The Laravel routing component allows all characters except /
. You must explicitly allow /
to be part of your placeholder using a where
condition regular expression:
Route::get('search/{search}', function ($search) {
return $search;
})->where('search', '.*');
Note: {note} Encoded forward slashes are only supported within the last route segment.
スラッシュのエンコードは、最後のルートセグメントでのみサポートしています。
名前付きルートNamed Routes
名前付きルートは特定のルートへのURLを生成したり、リダイレクトしたりする場合に便利です。ルート定義にname
メソッドをチェーンすることで、そのルートに名前がつけられます。Named routes allow the convenient generation of URLs or redirects for specific routes. You may specify a name for a route by chaining the name
method onto the route definition:
Route::get('user/profile', function () {
//
})->name('profile');
コントローラアクションに対しても名前を付けることができます。You may also specify route names for controller actions:
Route::get('user/profile', 'UserProfileController@show')->name('profile');
Note: {note} Route names should always be unique.
ルート名は常に一意にしてください。
名前付きルートへのURLを生成するGenerating URLs To Named Routes
ルートに一度名前を付ければ、その名前をグローバルなroute
関数で使用すれば、URLを生成したり、リダイレクトしたりできます。Once you have assigned a name to a given route, you may use the route's name when generating URLs or redirects via the global route
function:
// URLの生成
$url = route('profile');
// リダイレクトの生成
return redirect()->route('profile');
そのルートでパラメーターを定義してある場合は、route
関数の第2引数としてパラメーターを渡してください。指定されたパラメーターは自動的にURLの正しい場所へ埋め込まれます。If the named route defines parameters, you may pass the parameters as the second argument to the route
function. The given parameters will automatically be inserted into the URL in their correct positions:
Route::get('user/{id}/profile', function ($id) {
//
})->name('profile');
$url = route('profile', ['id' => 1]);
配列に追加のパラメーターを渡した場合、そうしたキー/値ペアは自動的にクエリ文字列として生成されるURLへ追加されます。If you pass additional parameters in the array, those key / value pairs will automatically be added to the generated URL's query string:
Route::get('user/{id}/profile', function ($id) {
//
})->name('profile');
$url = route('profile', ['id' => 1, 'photos' => 'yes']);
// /user/1/profile?photos=yes
">Tip!! たとえば現在のローケルのように、URLパラメータへ複数回のリクエスト間に渡るデフォルト値を指定したい場合も時々あります。このためには、
URL::defaults
メソッドを使用して下さい。{tip} Sometimes, you may wish to specify request-wide default values for URL parameters, such as the current locale. To accomplish this, you may use theURL::defaults
method[/docs/{{version}}/urls#default-values].
現在ルートの検査Inspecting The Current Route
現在のリクエストが指定した名前付きルートのものであるかを判定したい場合は、Routeインスタンスのnamed
メソッドを使います。たとえば、ルートミドルウェアから、現在のルート名を判定できます。If you would like to determine if the current request was routed to a given named route, you may use the named
method on a Route instance. For example, you may check the current route name from a route middleware:
/**
* 送信されたリクエストの処理
*
* @param \Illuminate\Http\Request $request
* @param \Closure $next
* @return mixed
*/
public function handle($request, Closure $next)
{
if ($request->route()->named('profile')) {
//
}
return $next($request);
}
ルートグループRoute Groups
ルートグループは多くのルートで共通なミドルウェアや名前空間のようなルート属性をルートごとに定義するのではなく、一括して適用するための手法です。Route::group
メソッドの最初の引数には、共通の属性を配列で指定します。Route groups allow you to share route attributes, such as middleware or namespaces, across a large number of routes without needing to define those attributes on each individual route. Shared attributes are specified in an array format as the first parameter to the Route::group
method.
グループをネストさせると、親のグループに対して属性をできるだけ賢く「マージ」します。ミドルウェアとwhere
条件はマージし、名前、名前空間、プレフィックスは追加します。名前空間のデリミタと、URIプレフィックス中のスラッシュは、自動的で適切に追加されます。Nested groups attempt to intelligently "merge" attributes with their parent group. Middleware and where
conditions are merged while names, namespaces, and prefixes are appended. Namespace delimiters and slashes in URI prefixes are automatically added where appropriate.
ミドルウェアMiddleware
グループ中の全ルートにミドルウェアを指定するには、そのグループを定義する前にmiddleware
メソッドを使用します。ミドルウェアは、配列に定義された順番で実行されます。To assign middleware to all routes within a group, you may use the middleware
method before defining the group. Middleware are executed in the order they are listed in the array:
Route::middleware(['first', 'second'])->group(function () {
Route::get('/', function () {
// firstとsecondミドルウェアを使用
});
Route::get('user/profile', function () {
// firstとsecondミドルウェアを使用
});
});
名前空間Namespaces
ルートグループのもう一つのよくあるユースケースで、グループ内のコントローラに同じPHP名前空間を指定する場合は、namespace
メソッドを使用します。Another common use-case for route groups is assigning the same PHP namespace to a group of controllers using the namespace
method:
Route::namespace('Admin')->group(function () {
// "App\Http\Controllers\Admin"名前空間下のコントローラ
});
App\Http\Controllers
名前空間をコントローラルート登録時に毎回指定しなくても済むように、デフォルトでRouteServiceProvider
が名前空間グループの中でroutes.php
ファイルを読み込み、指定していることを覚えておいてください。これにより、先頭のApp\Http\Controllers
名前空間を省略でき、続きの部分を指定するだけで済みます。Remember, by default, the RouteServiceProvider
includes your route files within a namespace group, allowing you to register controller routes without specifying the full App\Http\Controllers
namespace prefix. So, you only need to specify the portion of the namespace that comes after the base App\Http\Controllers
namespace.
サブドメインルーティングSubdomain Routing
ルートグループはワイルドカードサブドメインをルート定義するためにも使えます。サブドメインの部分を取り出しルートやコントローラで使用するために、ルートURIにおけるルートパラメーターのように指定できます。サブドメインはグループを定義する前に、domain
メソッドを呼び出し指定します。Route groups may also be used to handle subdomain routing. Subdomains may be assigned route parameters just like route URIs, allowing you to capture a portion of the subdomain for usage in your route or controller. The subdomain may be specified by calling the domain
method before defining the group:
Route::domain('{account}.myapp.com')->group(function () {
Route::get('user/{id}', function ($account, $id) {
//
});
});
Note: {note} In order to ensure your subdomain routes are reachable, you should register subdomain routes before registering root domain routes. This will prevent root domain routes from overwriting subdomain routes which have the same URI path.
サブドメインルートまで処理を確実に届けるには、ルートドメインルートより前にサブドメインルートを登録する必要があります。これにより、同じURIパスに対するサブドメインルートがルートドメインルートによりオーバーライドされるのを防げます。
ルートプレフィックスRoute Prefixes
prefix
メソッドはグループ内の各ルートに対して、指定されたURIのプレフィックスを指定するために使用します。たとえばグループ内の全ルートのURIにadmin
を付けたければ、次のように指定します。The prefix
method may be used to prefix each route in the group with a given URI. For example, you may want to prefix all route URIs within the group with admin
:
Route::prefix('admin')->group(function () {
Route::get('users', function () {
// Matches The "/admin/users" URL
});
});
ルート名プリフィックスRoute Name Prefixes
name
メソッドはグループ内の各ルート名へ、指定した文字列をプレフィックスするために使用します。たとえば、グループ内の全ルート名へadmin
というプレフィックスを付けたいとしましょう。指定した指定した文字列はそのままルート名の前に付きます。そのため、プレフィックスへ最後の.
文字を確実に指定してください。The name
method may be used to prefix each route name in the group with a given string. For example, you may want to prefix all of the grouped route's names with admin
. The given string is prefixed to the route name exactly as it is specified, so we will be sure to provide the trailing .
character in the prefix:
Route::name('admin.')->group(function () {
Route::get('users', function () {
// "admin.users"という名前へ結合したルート…
})->name('users');
});
モデル結合ルートRoute Model Binding
ルートかコントローラアクションへモデルIDが指定される場合、IDに対応するそのモデルを取得するため、大抵の場合クエリします。Laravelのモデル結合はルートへ直接、そのモデルインスタンスを自動的に注入する便利な手法を提供しています。つまり、ユーザーのIDが渡される代わりに、指定されたIDに一致するUser
モデルインスタンスが渡されます。When injecting a model ID to a route or controller action, you will often query to retrieve the model that corresponds to that ID. Laravel route model binding provides a convenient way to automatically inject the model instances directly into your routes. For example, instead of injecting a user's ID, you can inject the entire User
model instance that matches the given ID.
暗黙の結合Implicit Binding
Laravelはタイプヒントされた変数名とルートセグメント名が一致する場合、Laravelはルートかコントローラアクション中にEloquentモデルが定義されていると、自動的に依存解決します。Laravel automatically resolves Eloquent models defined in routes or controller actions whose type-hinted variable names match a route segment name. For example:
Route::get('api/users/{user}', function (App\User $user) {
return $user->email;
});
$user
変数がApp\User
Eloquentモデルとしてタイプヒントされており、変数名が{user}
URIセグメントと一致しているため、Laravelは、リクエストされたURIの対応する値に一致するIDを持つ、モデルインスタンスを自動的に注入します。一致するモデルインスタンスがデータベースへ存在しない場合、404 HTTPレスポンスが自動的に生成されます。Since the $user
variable is type-hinted as the App\User
Eloquent model and the variable name matches the {user}
URI segment, Laravel will automatically inject the model instance that has an ID matching the corresponding value from the request URI. If a matching model instance is not found in the database, a 404 HTTP response will automatically be generated.
キーのカスタマイズCustomizing The Key
id
以外のカラムを使用するEloquentモデルでも暗黙の結合を使いたい場合があるでしょう。それには、ルートパラメータ定義でカラムを指定してください。Sometimes you may wish to resolve Eloquent models using a column other than id
. To do so, you may specify the column in the route parameter definition:
Route::get('api/posts/{post:slug}', function (App\Post $post) {
return $post;
});
カスタムキーと取得Custom Keys & Scoping
一つの定義中に複数のEloquentモデルを暗黙的に結合し、2つ目のEloquentモデルが最初のEloquentモデルの子である必要がある場合などでは、その2つ目のモデルを取得したいと思うでしょう。例として、特定のユーザーのブログポストをスラグで取得する場合を想像してください。Sometimes, when implicitly binding multiple Eloquent models in a single route definition, you may wish to scope the second Eloquent model such that it must be a child of the first Eloquent model. For example, consider this situation that retrieves a blog post by slug for a specific user:
use App\Post;
use App\User;
Route::get('api/users/{user}/posts/{post:slug}', function (User $user, Post $post) {
return $post;
});
カスタムなキーを付けた暗黙の結合をネストしたルートパラメータで使用するとき、親で定義されるリレーションは慣習にしたがい名付けられているだろうとLaravelは推測し、ネストしたモデルへのクエリを自動的に制約します。この場合、User
モデルにはPost
モデルを取得するためにposts
(ルートパラメータ名の複数形)という名前のリレーションがあると想定します。When using a custom keyed implicit binding as a nested route parameter, Laravel will automatically scope the query to retrieve the nested model by its parent using conventions to guess the relationship name on the parent. In this case, it will be assumed that the User
model has a relationship named posts
(the plural of the route parameter name) which can be used to retrieve the Post
model.
デフォルトキー名のカスタマイズCustomizing The Default Key Name
特定のモデルの取得時に、id
以外のデフォルトデータベースカラム名を使用しモデル結合したい場合は、そのEloquentモデルのgetRouteKeyName
メソッドをオーバーライドしてください。If you would like model binding to use a default database column other than id
when retrieving a given model class, you may override the getRouteKeyName
method on the Eloquent model:
/**
* モデルのルートキーの取得
*
* @return string
*/
public function getRouteKeyName()
{
return 'slug';
}
明示的な結合Explicit Binding
明示的に結合を登録するには、ルータのmodel
メソッドで、渡されるパラメータに対するクラスを指定します。RouteServiceProvider
クラスのboot
メソッドの中で明示的なモデル結合を定義してください。To register an explicit binding, use the router's model
method to specify the class for a given parameter. You should define your explicit model bindings in the boot
method of the RouteServiceProvider
class:
public function boot()
{
parent::boot();
Route::model('user', App\User::class);
}
次に{user}
パラメーターを含むルートを定義します。Next, define a route that contains a {user}
parameter:
Route::get('profile/{user}', function (App\User $user) {
//
});
{user}
パラメーターをApp\User
モデルへ結合しているため、User
インスタンスはルートへ注入されます。ですからたとえば、profile/1
のリクエストでは、IDが1
のUser
インスタンスが注入されます。Since we have bound all {user}
parameters to the App\User
model, a User
instance will be injected into the route. So, for example, a request to profile/1
will inject the User
instance from the database which has an ID of 1
.
一致するモデルインスタンスがデータベース上に見つからない場合、404 HTTPレスポンスが自動的に生成されます。If a matching model instance is not found in the database, a 404 HTTP response will be automatically generated.
依存解決ロジックのカスタマイズCustomizing The Resolution Logic
独自の依存解決ロジックを使いたい場合は、Route::bind
メソッドを使います。bind
メソッドに渡す「クロージャ」は、URIセグメントの値を受け取るので、ルートへ注入したいクラスのインスタンスを返してください。If you wish to use your own resolution logic, you may use the Route::bind
method. The Closure
you pass to the bind
method will receive the value of the URI segment and should return the instance of the class that should be injected into the route:
/**
* アプリケーションサービスの初期処理
*
* @return void
*/
public function boot()
{
parent::boot();
Route::bind('user', function ($value) {
return App\User::where('name', $value)->firstOrFail();
});
}
別の方法として、EloquentモデルのresolveRouteBinding
メソッドをオーバーライドすることもできます。このメソッドはURIセグメントの値を受け取り、ルートへ注入すべきクラスのインスタンスを返す必要があります。Alternatively, you may override the resolveRouteBinding
method on your Eloquent model. This method will receive the value of the URI segment and should return the instance of the class that should be injected into the route:
/**
* 結合値のモデル取得
*
* @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();
}
フォールバックルートFallback Routes
Route::fallback
メソッドを使用すれば、受け取ったリクエストが他のルートと一致しない場合に、実行するルートを定義できます。通常、アプリケーションの例外ハンドラにより、処理できないリクエストに対し自動的に"404"ページがレンダーされます。しかしながら、routes/web.php
ファイルにfallback
ルートが定義されていれば、web
ミドルウェアグループの中のすべてのミドルウェアで、このルートが適用されます。必要に応じ、このルートを他のミドルウェアに追加するかどうかは、皆さんの自由です。Using the Route::fallback
method, you may define a route that will be executed when no other route matches the incoming request. Typically, unhandled requests will automatically render a "404" page via your application's exception handler. However, since you may define the fallback
route within your routes/web.php
file, all middleware in the web
middleware group will apply to the route. You are free to add additional middleware to this route as needed:
Route::fallback(function () {
//
});
Note: {note} The fallback route should always be the last route registered by your application.
フォールバックルートは、アプリケーションのルート登録で常に一番最後に行わなければなりません。
レート制限Rate Limiting
Laravelには、アプリケーションのルートに対してレート制限をかけるミドルウェア が用意されています。使用開始するには、ルートやルートグループに対し、throttle
ミドルウェアを指定してください。throttle
ミドルウェアは分数と、その時間内に許す最大リクエスト数の、2引数を取ります。例として、認証済みのユーザーが1分間に60回のアクセスを許すルートグループを指定してみましょう。Laravel includes a middleware[/docs/{{version}}/middleware] to rate limit access to routes within your application. To get started, assign the throttle
middleware to a route or a group of routes. The throttle
middleware accepts two parameters that determine the maximum number of requests that can be made in a given number of minutes. For example, let's specify that an authenticated user may access the following group of routes 60 times per minute:
Route::middleware('auth:api', 'throttle:60,1')->group(function () {
Route::get('/user', function () {
//
});
});
動的レート制限Dynamic Rate Limiting
認証済みUser
モデルの属性に基づいて、最大リクエストを動的に指定することもできます。たとえば、User
モデルがrate_limit
属性を含んでいる場合、最大リクエストの算出で使用するために、throttle
ミドルウェアにその属性の名前を渡します。You may specify a dynamic request maximum based on an attribute of the authenticated User
model. For example, if your User
model contains a rate_limit
attribute, you may pass the name of the attribute to the throttle
middleware so that it is used to calculate the maximum request count:
Route::middleware('auth:api', 'throttle:rate_limit,1')->group(function () {
Route::get('/user', function () {
//
});
});
ゲストと認証ユーザー別のレート制限Distinct Guest & Authenticated User Rate Limits
ゲストと認証済みユーザーで別のレート制限を適用できます。たとえば、ゲストには1分間に最大10
回、認証済みユーザーでは最大60
回を指定するとしましょう。You may specify different rate limits for guest and authenticated users. For example, you may specify a maximum of 10
requests per minute for guests 60
for authenticated users:
Route::middleware('throttle:10|60,1')->group(function () {
//
});
この機能を動的レート制限と組み合わせることもできます。たとえばUser
モデルにrate_limit
属性があるとして、この属性名をthrottle
ミドルウェアへ渡し、その認証ユーザーの最大リクエスト回数を指定するために使うことができます。You may also combine this functionality with dynamic rate limits. For example, if your User
model contains a rate_limit
attribute, you may pass the name of the attribute to the throttle
middleware so that it is used to calculate the maximum request count for authenticated users:
Route::middleware('auth:api', 'throttle:10|rate_limit,1')->group(function () {
Route::get('/user', function () {
//
});
});
レート制限区分Rate Limit Segments
通常、アプリケーション全体のAPIに対し1つのレート制限を指定します。しかしながら、アプリケーションの別々の区分に別個の制限が必要になる場合もあります。このようなケースでは、throttle
ミドルウェアの第3引数にセグメント名を渡してください。Typically, you will probably specify one rate limit for your entire API. However, your application may require different rate limits for different segments of your API. If this is the case, you will need to pass a segment name as the third argument to the throttle
middleware:
Route::middleware('auth:api')->group(function () {
Route::middleware('throttle:60,1,default')->group(function () {
Route::get('/servers', function () {
//
});
});
Route::middleware('throttle:60,1,deletes')->group(function () {
Route::delete('/servers/{id}', function () {
//
});
});
});
擬似フォームメソッドForm Method Spoofing
HTMLフォームはPUT
、PATCH
、DELETE
アクションをサポートしていません。ですから、HTMLフォームから呼ばれるPUT
、PATCH
、DELETE
ルートを定義する時、フォームに_method
隠しフィールドを追加する必要があります。_method
フィールドとして送られた値は、HTTPリクエストメソッドとして使用されます。HTML forms do not support PUT
, PATCH
or DELETE
actions. So, when defining PUT
, PATCH
or DELETE
routes that are called from an HTML form, you will need to add a hidden _method
field to the form. The value sent with the _method
field will be used as the HTTP request method:
<form action="/foo/bar" method="POST">
<input type="hidden" name="_method" value="PUT">
<input type="hidden" name="_token" value="{{ csrf_token() }}">
</form>
_method
フィールドを生成するために、@method
Bladeディレクティブを使用することもできます。You may use the @method
Blade directive to generate the _method
input:
<form action="/foo/bar" method="POST">
@method('PUT')
@csrf
</form>
現在のルートへのアクセスAccessing The Current Route
送信されたリクエストを処理しているルートに関する情報へアクセスするには、Route
ファサードへcurrent
、currentRouteName
、currentRouteAction
メソッドを使用します。You may use the current
, currentRouteName
, and currentRouteAction
methods on the Route
facade to access information about the route handling the incoming request:
$route = Route::current();
$name = Route::currentRouteName();
$action = Route::currentRouteAction();
組み込まれている全メソッドを確認するには、Routeファサードの裏で動作しているクラスと、Routeインスタンスの2つについてのAPIドキュメントを参照してください。Refer to the API documentation for both the underlying class of the Route facade[https://laravel.com/api/{{version}}/Illuminate/Routing/Router.html] and Route instance[https://laravel.com/api/{{version}}/Illuminate/Routing/Route.html] to review all accessible methods.
Cross-Origin Resource Sharing (CORS)Cross-Origin Resource Sharing (CORS)
Laravelは指定値に従い自動的にCORSオプションリクエストへ対応します。CORSの設定はすべてcors
設定ファイルで行われ、オプションリクエストはグローバルミドルウェアスタックにデフォルトで含まれるHandleCors
ミドルウェアにより自動的に処理されます。Laravel can automatically respond to CORS OPTIONS requests with values that you configure. All CORS settings may be configured in your cors
configuration file and OPTIONS requests will automatically be handled by the HandleCors
middleware that is included by default in your global middleware stack.
CROSに関するMDN Webドキュメンテーションで調べてください。{tip} For more information on CORS and CORS headers, please consult the MDN web documentation on CORS[https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#The_HTTP_response_headers].
">Tip!! CORSとそのヘッダの詳細は、