Visual Studio CodeでLaravelを実行する方法を教えてください。

Question

Visual Studio CodeでLaravelをWeb apiとして動くようにしたいです。
MVCフレームワークの経験はありますが、Laravelの構築方法がわかっていなく、ネットで調べていますが、解決できなく困ってます。

VS CodeのXDebugで実行する方法と、localのhtdocでXAMPPで実行する方法の2つ
がわからなくて困っています。

Windowsで環境を構築しています。
もしわかれば教えてください。

インストールしたもの

XAMPP
Composer
Visual Studio Code (拡張機能としてPHP Debugを追加)
php_xdebug-3.1.5-8.1-vs16-x86_64.dll　を　C:\xampp\php\ext\　に追加

設定したもの

・php.iniにXDebugの設定を追加
・80ポートを使用しているアプリは無し

[XDebug]
zend_extension = C:\xampp\php\ext\php_xdebug-2.9.2-7.4-vc15-x86_64.dll
xdebug.remote_enable = 1
xdebug.remote_autostart = 1
xdebug.remote_host = localhost
xdebug.remote_port = 9000

・ComposerでLaravel 9をsampleプロジェクトとして作成、C:\xampp\htdocにフォルダを移動

・スタートメニューから「XAMPP」を管理者権限で実行
ApacheのServiceを有効化
ConfigにApacheをチェック
→　Stop / Startで再起動 (有効化された)

プロジェクト

APIとして利用したいため、Controllerの追加とapi.phpにルートを追加

SampleController.php

<?php
namespace App\Http\Controllers;
use Illuminate\Http\Request;

class SampleController extends Controller {
    public function do(Request $request) {
        $value = request("value");

        return response()->json([
            "message" => "200 OK: " . $value
        ], 200);
    }
}

api.phpに1行追加

Route::get('sample/{value}', 'SampleController@do');

XAMPPの再起動と、php artisan serveの実行

PHPコードを編集したので、ここでXAMPPはもう一度再起動

コマンドプロンプトでphp artisan serveを実行したところdllのWARNが発生しました。

cd C:\xampp\htdocs\sample
php artisan serve

Failed loading C:\xampp\php\ext\php_xdebug-2.9.2-7.4-vc15-x86_64.dll
WARN Failed loading C:\xampp\php\ext\php_xdebug-2.9.2-7.4-vc15-x86_64.dll
INFO Server running on [http://127.0.0.1:8000]
Press Ctrl+C to stop the server

結果

①http://localhost/　
にアクセスしたところ、ディレクトリしか表示されなかった。

②http://localhost:8000/
にアクセスしたところ、Laravelのデフォルトページが表示された。

③http://localhost:8000/api/Sample/do?value=abc
にアクセスしたところ、400 | NOT FOUND　が発生した。

確認したいこと

・laravelが動く条件は、apacheが有効、かつphp artisan serveを実行していることという認識で合ってますか？

・ローカルのテストだとしても、デバッグ用フォルダとhtdocフォルダの2つに分けるべきですか？

・php artisan serveを実行したところXDebug用のdll読み込みのWARNの原因はわかりますでしょうか？

・結果がうまくいかなかった原因がわかれば教えていただきたいです。

よろしくお願いいたします。

Answer 1

Route::get('sample/{value}'

ならURLは
/api/Sample/do?value=abc
↓
/api/sample/abc

では。

あと
public function do(Request $request) {
↓
public function do(Request $request,$value) {

$value = request("value");

これは不要。（というかリクエストの取り方違う）

ルーティング
コントローラ
リクエスト

Comments

[pom12345]

ありがとうございます。
どの言語でも困ったらドキュメントを確認を忘れていました。ネット記事よりも正しいことがみつかりそうです。

/api/Sample/do?value=abc　　こうしたかったのですが、
Routeの書き方が間違っているみたいです。

また、Laravel9はこのような書き方をしているみたいなので合わせる必要があるのかどうか..
Route::put('/user/{id}', [UserController::class, 'update']);

GETアクセスだと、引数に$valueが書けるんですね。

[m.ts10806]

>/api/Sample/do?value=abc　　こうしたかったのですが、
>Routeの書き方が間違っているみたいです。

クエリストリングにしたいならURLに変数含めずに設定してクエリストリングでアクセスして
$requestから取得すればいいのではないでしょうか。
ルーティングは /Sample/do だけでOK

＞GETアクセスだと、引数に$valueが書けるんですね。

いいえ。リクエストURIに動的情報を含めることができ、それをコントローラにてルーティングで指定した名称（{名称}）の変数名（$名称）で受け取れるだけです。
ちょうどteratailも同じ方式のルーティングになってます（フレームワークは違うだろうけど）

[pom12345]

教えていただいた方法の解釈がまちがっているかもしれません。現在ドキュメントも読んではいますが。
Routeの書き方は[]のタイプと2パターンあるのでしょうか？

ひとまずこれで動作をすることができました。

--- api.php ---
use App\Http\Controllers\SampleController;
// Route::get('Sample/do', 'SampleController@do'); // なしにした
Route::get('Sample/do', [SampleController::class, 'do']);

--- SampelController.php ---
<?php
namespace App\Http\Controllers;
use Illuminate\Http\Request;

class SampleController extends Controller {
public function do(Request $request) {
$value = request("value");

return response()->json([
"message" => "200 OK: " . $value
], 200);
}
}

[m.ts10806]

>Routeの書き方は[]のタイプと2パターンあるのでしょうか？
色々あるのでそこはドキュメント確認してくださいとしか。。

＞$value = request("value");
do()の引数意味ないような・・・。

[pom12345]

ありがとうございます。Routeの書き方は調べてみます。
サンプルなので適当にdoをつけています。ほかにも良い方法があるのかもしれません。

他のフレームワークでGETとPOSTしかつかっていなかったのでメソッド名がないと違和感があります。
PHPではPUT DELETEもよく使うんですね。

質問にも記載させていただいたことを含みますが、もしわかれば教えてください。

・XDebugがうまくいかなく困っています。
　php artisan serveを実行したところXDebug用のdll読み込みのWARNはでていました。

・ローカルのSampleプロジェクトでも、デバッグ用フォルダとhtdocのフォルダの2つに分けるべきですか？

　また、フォルダを分けたとして、
　htdocs内のプロジェクトを更新したとき、デバッグ用のプロジェクトを更新したとき
　のそれぞれで、apacheとphp artisan serveは再起動する必要があるかどうか。

・htdocsにSampleプロジェクトを配置したとして、XAMPP経由で動作させることができなくて困っています。

よろしくお願いいたします

[m.ts10806]

>サンプルなので適当にdoをつけています。

リクエストURIの問題なので設計に合わせて調整を。

>PHPではPUT DELETEもよく使うんですね。

フレームワークの設計思想によると思います。
確かHTML自体がPOSTとGETしか送信は出来ないので、
フレームワーク独自の仕様で「別の要素（hidden）によってそういうリクエストとしてみなす」ように設計されているものかと。

>・ローカルのSampleプロジェクトでも、デバッグ用フォルダとhtdocのフォルダの2つに分けるべきですか？

「デバッグ」をどう位置付けているかによります。
通常アプリケーションに対して行いますしAPIとてhttpアクセスできる先です。
ただ、フレームワークだとそもそもドキュメントルート配下にindex.php等しかないケースもあるので、
そこはデバッグ先によって、でしょうか。
私が質問者さんのコメントを理解しきれてないかもしれません。

＞・htdocsにSampleプロジェクトを配置したとして、XAMPP経由で動作させることができなくて困っています。

どういう風に配置したのでしょうか。
アクセスしたい先にあわせてドキュメントルート、Webルートの調整が必要ではと。
（バージョンによって違うかもしれません。publicディレクトリについての言及がないバージョンもあるようですし）

[pom12345]

なるほどです、フレームワークによっていろいろ違うんですね。
なるべくPUT DELETEを使いたくないですが、フレームワークがその思想なら使わざるを得ないですね。

htdocs外に配置したところ、XAMPPを起動せずに、php artisan serveのみでVS Codeで実行することができました。(VS CodeでXAMPPを使っているのかも？)
ただ、XDebugの設定が自分でインストールしたXAMPPなのでhtdocsに置く必要があるかもしれません。
XDebugは動いてはないですが。

再起動の有無はどのタイミングかはわかりませんが。

XAMPP経由で動作させないについてはおっしゃられているとおり、ドキュメントルート、Webルートの調整が必要と思われるのでもう少し調べます。

今はこのようにプロジェクトフォルダを配置しただけでしたので、
C:\xampp\htdocs\
Sample
webalizer
xampp
applications.html
bitnami.css
favicon.ico
index.php
dashboard
img

それが解決すればXDebugも動くのかもしれません。

[m.ts10806]

XDebugについてはいったん整理して別質問にしたほうが良いと思います。
タイトルと別要件ですし

[pom12345]

わかりました。ありがとうございます。
もう少し調べてから質問させていただきます。