これと同じようなことをしています。
<a href="/posts/p1557">リンク</a>
Laravelのバージョンは9でしたが、新機能とか使ってないので8でも問題ありません。
<h2>リクエスト</h2>
リクエストはパラメータを付与してあげると、Requestを経由して取得できますのでその方法で行いました。
<img src="/1568/1.png" alt="画像">
コントローラーは以下のようになっています。
<div class="remark-highlight"><pre class="language-php"><code class="language-php">// 実際のusersテーブルを利用しますが、認証処理を行いません。
 public function play(Request $request) {
 // requestのバリデーションは省略しています。

 // ユーザーIDは本来認証情報から取得します。
 $result = $this->gachaService->play($request->user_id, $request->type);

 // 結果はjsonで返却する
 return response()->json($result->toArray());

 }
</code></pre></div>
<h2>レスポンス</h2>
response()->jsonで返してあげるとjson形式になります。この時連想配列の形式にしてあげると良いのでtoArray()メソッドを実装しています。
<div class="remark-highlight"><pre class="language-html"><code class="language-html">public function toArray() : array{
 
 // response->json()に適合させるために連想配列に変換します。
 return array_map(function(CharacterData $character){
 return [
 'lank' => $character->getLank(),
 'name' => $character->getName(),
 ];
 },$this->characters);

 }
</code></pre></div>
これを確実に保証するためにArrayableインターフェースを実装してあげるといいです。※後で入れたので戻り値の型がCharacterListになっています。コントローラーからはtoArrayメソッドしか呼ぶ必要がないので、戻り値の型をArrayableに変更して良いです
<h2>データアクセス</h2>
正しいかわかりませんが挑戦という形で、今回はEloquentモデルはRepository内だけで利用するようにしました。なんとなくDAO的な立ち位置に持ってきたようだったので、ロジックを含めないほうが良いと判断しました。
<div class="remark-highlight"><pre class="language-php"><code class="language-php">class UserDataRepositoryImpl implements UserDataRepository{
 
 function find(int $user_id) : UserData{
 $user = User::find($user_id);
 $mapper = new UserDataMapper();
 return $mapper->toUserData($user);
 }

 function save(UserData $userData) : void {
 $user = User::find($userData->getId());
 $user->stone_amt = $userData->getStoneAmt();
 $user->save();
 }
}
</code></pre></div>
<h2>リスト</h2>
PHPの配列は便利な高階関数がいくつか用意されているので扱いは便利ですが、型を意識できないのが少し貧弱だなと思ってしまいます。
そのため専用のクラスを作って管理できるようにしました。
<div class="remark-highlight"><pre class="language-php"><code class="language-php">class CharacterList implements Arrayable{

 // キャラクターのリスト
 private array $characters = array();

 public function getCharactersList() : array {
 return $this->characters;
 }
</code></pre></div>
配列の型を指定するにはarray_mapなどの高階関数を利用すると便利です。
<div class="remark-highlight"><pre class="language-php"><code class="language-php">/**
 * Cahracterのリストを全てCharacterDataに変換してリストに追加します
 */
 public function addCharactersToData(array $characters){
 $mapper = new CharacterDataMapper();
 
 $list = array_map(function(Character $character) use ($mapper) {
 return $mapper->toCharacterData($character);
 },$characters);

 $this->characters = array_merge($this->characters, $list);
 }
</code></pre></div>
array_mapの第一引数は関数で、引数には配列の要素が入ってきます。この時に型を指定してあげれば要素の型が異なる配列を排除できます。
<h2>DTO</h2>
DTOクラスを用意してもよかったのかもしれませんが、最終的にtoArrayメソッドで配列になるのでそこは省略しちゃいました。
<h2>エラーハンドリング</h2>
<ul>
<li>独自の例外クラスを作成して、その例外クラスをスローするようにしました。</li>
<li>例外クラスはコマンドで作成可能です。
<ul>
<li>php artisan make:exception ApiException</li>
</ul>
</li>
<li>例外発生時にrenderメソッドが呼ばれます</li>
</ul>
<div class="remark-highlight"><pre class="language-php"><code class="language-php">class ApiException extends Exception
{
 private array $messages = array();

 public function __construct(array $messages)
 {
 $this->messages = $messages;
 }

 public function render(){
 return response()->json($this->messages);
 }

}
</code></pre></div>
コンストラクタの引数でメッセージの配列を受取っています。これは連想配列にします。
<div class="remark-highlight"><pre class="language-php"><code class="language-php">if(!$userData->useStone(3000)){
 // error
 throw new ApiException(['result' => 'ガチャ石が足りません']);
 }
</code></pre></div>

LaravelでAPI開発