1.

ルーティング一覧の確認方法

編集

以下のコマンドを実行することでLaravelのルーティング一覧を確認することが出来ます。アプリで定義されている全URL・HTTPメソッド・処理を担うコントローラを一望できるため、開発・デバッグ時の基本コマンドです。

基本コマンド

php artisan route:list

プロジェクトルートで実行します。出力にはHTTPメソッド、URI、名前、コントローラ@メソッド、ミドルウェア等が並びます。

絞り込みオプション

オプション用途
--method=GETHTTPメソッドで絞り込み
--name=user.ルート名で絞り込み(部分一致)
--path=apiURIパスで絞り込み(部分一致)
--except-vendorvendor配下から登録されたルートを除外
--only-vendorvendor配下のルートだけ表示
--compact / -cカラム圧縮表示
--jsonJSON形式で出力(スクリプト連携向け)

実行例

$ php artisan route:list --method=GET --path=user
$ php artisan route:list --name=admin.
$ php artisan route:list --except-vendor

表示が崩れるとき

ターミナル幅が狭いと改行で表が崩れます。-c(コンパクト)か --json | jq がおすすめです。

$ php artisan route:list --json | jq '.[] | {method, uri, name}'

ルートキャッシュとの関係

  • php artisan route:cache はルート定義をコンパイル&キャッシュする本番向け最適化
  • キャッシュが残っていると、route:list の結果がコード変更後と一致しないことがある
  • 開発中は php artisan route:clear を実行してキャッシュをクリアする

$ php artisan route:clear
$ php artisan route:cache  # 本番用

関連

注意点

  • 本番ではアプリ起動の高速化のため route:cache を打っておくのが定石。ただしキャッシュ後にルートを書き換えたら必ず route:clear
  • クロージャ(無名関数)で定義されたルートは route:cache でエラーになる。本番向けはコントローラ参照に書き換える
編集
Post Share
子ページ

子ページはありません

同階層のページ
  1. ルーティング一覧の確認方法
  2. ルーティングのグループ化