PHP Academy · レッスン

APIリソースとJSONレスポンス

Q: 「APIリソースとJSONレスポンス」で何を学びますか？

Eloquent API ResourcesとResourceCollectionsでJSON出力を整形します ブラウザで直接実行するハンズオンコードでPHP Academyを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

Eloquent API ResourcesとResourceCollectionsでJSON出力を整形します

「APIリソースとJSONレスポンス」はCoddyKit上の無料PHP Academyレッスンです。これはレッスン2/4です。下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。これはPHP Academy学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 PHP Academyコースには全4レッスンが含まれています。

APIリソースとは

Eloquent API ResourcesはモデルやコレクションをJSON対応の配列に変換し、APIレスポンスの形を完全に制御できるようにします。

リソースの生成

Artisanでリソースクラスを作成します。

$ php artisan make:resource UserResource
# For collections:
$ php artisan make:resource UserCollection

基本的なリソース

toArray()をオーバーライドしてJSONの構造を定義します。

<?php
namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

class UserResource extends JsonResource
{
    public function toArray($request): array
    {
        return [
            "id"         => $this->id,
            "name"       => $this->name,
            "email"      => $this->email,
            "created_at" => $this->created_at->toISOString(),
        ];
    }
}

リソースの返却

コントローラーからリソースを返すと、モデルが自動的にdataキーでラップされます。

<?php
public function show(User $user): UserResource
{
    return new UserResource($user);
}
// Response: {"data": {"id": 1, "name": "Alice", ...}}

リソースコレクション

::collection()を使ってモデルのコレクションをラップします。

<?php
public function index(): AnonymousResourceCollection
{
    return UserResource::collection(User::paginate(15));
}

条件付きフィールド

when()を使うと、条件を満たす場合にだけフィールドを含められます。

<?php
return [
    "id"    => $this->id,
    "email" => $this->when($request->user()?->isAdmin(), $this->email),
    "token" => $this->whenLoaded("tokens", $this->tokens->first()->plainTextToken),
];

whenLoaded()

リレーションがすでに読み込まれている場合にだけ、条件付きでリレーションを含めます。リソースのレスポンスでN+1問題が発生するのを防げます。

<?php
return [
    "id"      => $this->id,
    "posts"   => PostResource::collection($this->whenLoaded("posts")),
    "profile" => new ProfileResource($this->whenLoaded("profile")),
];

ネストされたリソース

他のリソース内にリソースをネストして、豊富で型の明確なレスポンス構造を作成します。

<?php
return [
    "id"     => $this->id,
    "author" => new UserResource($this->author),
    "tags"   => TagResource::collection($this->tags),
];

追加のメタデータ

with()をオーバーライドして、レスポンスにメタデータを追加します。

<?php
public function with($request): array
{
    return [
        "meta" => ["version" => "1.0"],
    ];
}

ラッピング

デフォルトでは、リソースはdataキーでラップされます。JsonResource::withoutWrapping()を使うと、全体でラッピングを無効にできます。

<?php
// In AppServiceProvider::boot():
JsonResource::withoutWrapping();

リソースのページネーション

ページネーターをリソースコレクションに渡すと、ページネーションのメタデータが自動的に含まれます。

<?php
return UserResource::collection(User::paginate(15));
// Response includes: data[], links{}, meta{}

リソースのテスト

assertJson()またはassertJsonStructure()を使って、テストでリソースの構造を検証します。

<?php
$response->assertJsonStructure([
    "data" => ["id", "name", "email"]
]);

まとめ

APIリソースはJSON出力の形を制御します。条件付きフィールドにはwhen()とwhenLoaded()を使用します。リレーションにはリソースをネストします。複数のモデルには::collection()を使用します。

理解度チェック

リレーションがすでに読み込まれている場合にだけ、条件付きで含めるメソッドはどれですか？

よくある質問

「APIリソースとJSONレスポンス」レッスンは無料ですか？

はい。「APIリソースとJSONレスポンス」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、PHP Academyコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 PHP Academyコースには全4レッスンが含まれています。

「APIリソースとJSONレスポンス」で何を学びますか？

Eloquent API ResourcesとResourceCollectionsでJSON出力を整形しますブラウザで直接実行するハンズオンコードでPHP Academyを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

PHP Academyを始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのPHP Academyは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。これはレッスン2/4です。

「APIリソースとJSONレスポンス」レッスンにはどのくらい時間がかかりますか？

ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このPHP Academyレッスンでコードを書いて実行できますか？

はい。すべてのPHP Academyレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

← PHP Academyに戻る