php artisan route:list

ピーエイチピーアーティザンルートリスト（Artisanコマンド）

意味アプリケーションの全ルートを表示

php artisan route:listとは？

このコマンドは、アプリケーションで定義されているすべてのルートのリストを表示します。各ルートのHTTPメソッド、URI、コントローラアクションなどの情報が含まれます。

php artisan route:listの具体的な使い方

すべてのルートの表示

php artisan route:list

👇出力結果

+--------+----------+-------------------+------+-------------------------------------+---------------------+
| Domain | Method   | URI               | Name | Action                                | Middleware          |
+--------+----------+-------------------+------+-------------------------------------+---------------------+
|        | GET|HEAD | /                 |      | Closure                              | web                 |
|        | GET|HEAD | api/user          |      | App\Http\Controllers\UserController | api,auth:sanctum    |
|        | POST     | login             |      | App\Http\Controllers\AuthController | web,guest           |
|        | GET|HEAD | dashboard         |      | App\Http\Controllers\DashboardContr | web,auth            |
+--------+----------+-------------------+------+-------------------------------------+---------------------+

このコマンドは、アプリケーションで定義されているすべてのルートを表形式で表示します。HTTPメソッド、URI、名前、アクション、ミドルウェアなどの情報が含まれます。

特定のHTTPメソッドのルートの表示

php artisan route:list --method=POST

👇出力結果

+--------+--------+-------------------+------+-------------------------------------+---------------------+
| Domain | Method | URI               | Name | Action                                | Middleware          |
+--------+--------+-------------------+------+-------------------------------------+---------------------+
|        | POST   | login             |      | App\Http\Controllers\AuthController | web,guest           |
|        | POST   | api/users         |      | App\Http\Controllers\UserController | api,auth:sanctum    |
+--------+--------+-------------------+------+-------------------------------------+---------------------+

--methodオプションを使用して、特定のHTTPメソッド（GET、POST、PUT、DELETEなど）のルートのみを表示できます。この例では、POSTメソッドのルートのみを表示しています。

特定のパスのルートの表示

php artisan route:list --path=api

👇出力結果

+--------+----------+-------------------+------+-------------------------------------+---------------------+
| Domain | Method   | URI               | Name | Action                                | Middleware          |
+--------+----------+-------------------+------+-------------------------------------+---------------------+
|        | GET|HEAD | api/user          |      | App\Http\Controllers\UserController | api,auth:sanctum    |
|        | POST     | api/users         |      | App\Http\Controllers\UserController | api,auth:sanctum    |
|        | GET|HEAD | api/products      |      | App\Http\Controllers\ProductContro | api                 |
+--------+----------+-------------------+------+-------------------------------------+---------------------+

--pathオプションを使用して、特定のパスを含むルートのみを表示できます。この例では、URIに「api」を含むルートのみを表示しています。

php artisan route:listに関するよくある質問

Q. 特定のルートだけ表示できますか？

A. はい、'--path'オプションを使用して特定のパスのルートを絞り込むことができます。例：'php artisan route:list --path=api'

Q. HTTPメソッドでフィルタできますか？

A. はい、'--method'オプションを使用して特定のHTTPメソッドのルートのみを表示できます。例：'php artisan route:list --method=GET'

Q. ミドルウェアの情報も見れますか？

A. はい、デフォルトでミドルウェアの情報も表示されます。特定のミドルウェアを持つルートだけを表示したい場合は、'--middleware'オプションを使用できます。

Laravelのphp artisan route:listについても学べる書籍の紹介

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

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