How to Create API Resource Class in Laravel Easily

In Laravel, create an API resource class using the php artisan make:resource ResourceName command. This class helps format your model data into JSON for API responses by defining a toArray method.

Syntax

Use the Artisan command to create a resource class. The class extends Illuminate\Http\Resources\Json\JsonResource and requires a toArray method to define how the model data is transformed.

• php artisan make:resource ResourceName: Creates the resource class file.
• toArray($request): Returns an array representation of the resource.

bash and php

php artisan make:resource ResourceName

// Inside app/Http/Resources/ResourceName.php
namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

class ResourceName extends JsonResource
{
    public function toArray($request)
    {
        return [
            // Define the fields to return
            'id' => $this->id,
            'name' => $this->name,
            // add more fields as needed
        ];
    }
}

Example

This example shows how to create a UserResource to format user data for API responses. It returns only the user's id, name, and email.

php

php artisan make:resource UserResource

// app/Http/Resources/UserResource.php
namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

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

// Usage in a controller method
use App\Http\Resources\UserResource;
use App\Models\User;

public function show($id)
{
    $user = User::findOrFail($id);
    return new UserResource($user);
}

Output

{
  "id": 1,
  "name": "John Doe",
  "email": "[e-mail]"
}

Common Pitfalls

Common mistakes when creating API resource classes include:

• Not returning an array in toArray method, which causes errors.
• Trying to access properties that do not exist on the model.
• Forgetting to import the resource class in the controller before using it.
• Using resource classes for non-API responses, which can cause unexpected output.

php

/* Wrong: toArray returns a string instead of array */
public function toArray($request)
{
    return 'User data'; // Incorrect
}

/* Right: toArray returns an array */
public function toArray($request)
{
    return [
        'id' => $this->id,
        'name' => $this->name,
    ];
}

Quick Reference

Summary tips for creating API resource classes in Laravel:

• Use php artisan make:resource ResourceName to generate the class.
• Define the toArray method to specify the JSON structure.
• Return arrays, not strings, from toArray.
• Use resource classes in controllers to return clean API responses.
• Remember to import the resource class with use statement.

Key Takeaways

Create API resource classes with the Artisan command for clean JSON responses.

Always return an array from the toArray method to define the output structure.

Use resource classes in controllers to format model data for APIs.

Import resource classes properly before using them.

Avoid accessing undefined model properties inside the resource.