PHP Academy · Lektion

API-resources og JSON-svar

Formgiv JSON-output med Eloquent API Resources og ResourceCollections.

Lektion 2 af 414 trin

API-resources og JSON-svar er en gratis PHP Academy-lektion på CoddyKit. Dette er lektion 2 af 4. Du kan læse hele lektionen gratis nedenfor — og derefter øve dig praktisk i browseren med en indbygget kodeeditor og en AI-vejleder, der er tilgængelig døgnet rundt. Den er en del af læringsforløbet i PHP Academy, og dine fremskridt synkroniseres på tværs af nettet og CoddyKit-appen. PHP Academy-kurset indeholder 4 lektioner i alt.

Hvad er API-ressourcer?

Eloquent API Resources omdanner modeller og samlinger til JSON-klare lister, så du har fuld kontrol over strukturen af dine API-svar.

Generering af en ressource

Opret en ressourceklasse med Artisan.

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

Grundlæggende ressource

Tilsidesæt toArray() for at definere JSON-strukturen.

<?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(),
        ];
    }
}

Returnering af en ressource

Returner ressourcen fra en styreenhed — den indpakker automatisk modellen i en data-nøgle.

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

Ressourcesamlinger

Indpak en samling modeller med ::collection().

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

Betingede felter

Medtag kun et felt, når en betingelse er opfyldt, ved hjælp af when().

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

whenLoaded()

Medtag kun en relation, hvis den allerede er indlæst — det undgår N+1 i ressourcesvar.

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

Indlejrede ressourcer

Indlejr ressourcer i andre ressourcer for at skabe rige, typede svarstrukturer.

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

Yderligere metadata

Føj metadata til svaret ved at tilsidesætte with().

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

Indpakning

Som standard indpakkes ressourcer i en data-nøgle. Deaktivér indpakning globalt med JsonResource::withoutWrapping().

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

Paginering i ressourcer

Pagineringsmetadata medtages automatisk, når du sender en paginator til en ressourcesamling.

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

Test af ressourcer

Kontroller ressourcestrukturen i test med assertJson() eller assertJsonStructure().

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

Opsummering

API-ressourcer styrer strukturen af dit JSON-output. Brug when() og whenLoaded() til betingede felter. Indlejr ressourcer for relationer. Brug ::collection() til flere modeller.

Hurtigt tjek

Hvilken metode medtager kun en relation, hvis den allerede er indlæst?

Gratis at komme i gang

Lær PHP med en AI-underviser — gratis

Skriv og kør rigtig kode i din browser, få øjeblikkelig hjælp fra en AI-underviser døgnet rundt, og fortsæt, hvor du slap, på web eller i appen.

Kurser
49
Lektioner
195

Ofte stillede spørgsmål

Er lektionen “API-resources og JSON-svar” gratis?

Ja — hele teksten til “API-resources og JSON-svar” kan læses gratis her på nettet. Hvis du vil øve dig interaktivt med en indbygget kodeeditor og en AI-vejleder døgnet rundt og få adgang til resten af PHP Academy-kurset, skal du opgradere til CoddyKit PRO. PHP Academy-kurset indeholder 4 lektioner i alt.

Hvad lærer jeg i “API-resources og JSON-svar”?

Formgiv JSON-output med Eloquent API Resources og ResourceCollections. Du øver dig i PHP Academy med praktisk kode, som du kører direkte i browseren, og en AI-vejleder døgnet rundt besvarer dine spørgsmål, mens du arbejder dig gennem lektionen.

Skal jeg have erfaring for at begynde på PHP Academy?

Der kræves ingen tidligere erfaring. PHP Academy på CoddyKit er tilrettelagt for både begyndere og øvede, så du kan starte her eller fra begyndelsen og lære i dit eget tempo. Dette er lektion 2 af 4.

Hvor lang tid tager lektionen “API-resources og JSON-svar”?

De fleste CoddyKit-lektioner tager cirka 5–10 minutter. Hver lektion er kort og interaktiv, så du gør løbende fremskridt og kan fortsætte, hvor du slap – på både web og app.

Kan jeg skrive og køre kode i denne PHP Academy-lektion?

Ja. Alle PHP Academy-lektioner har en indbygget kodeeditor, så du kan skrive og køre rigtig kode direkte i din browser og få øjeblikkelig feedback fra AI – uden lokal opsætning.

Alle lektioner i dette kursus

  1. API-routes og resource-controllere
  2. API-resources og JSON-svar
  3. Godkendelse med Laravel Sanctum
  4. Ratebegrænsning og API-versionering
← Tilbage til PHP Academy