API resource classes in Laravel - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to create a basic API resource class in Laravel.

Laravel

use Illuminate\Http\Resources\Json\JsonResource;

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

Drag options to blanks, or click blank then click option'

Aname

Busername

Cuser

Dfullname

Attempts:

3 left

💡 Hint

Common Mistakes

Using an attribute that does not exist on the User model.

Confusing the attribute with username or fullname.

The property name is the correct attribute to return the user's name in the resource.

2fill in blank

medium

Complete the code to return a collection of users using the resource class.

Laravel

use App\Http\Resources\UserResource;
use App\Models\User;

public function index()
{
    $users = User::all();
    return UserResource::[1]($users);
}

Drag options to blanks, or click blank then click option'

Amake

Bresource

Ccollection

Dall

Attempts:

3 left

💡 Hint

Common Mistakes

Using make which is for single models.

Using all which is a query method, not a resource method.

The collection method wraps a collection of models into a resource collection.

3fill in blank

hard

Fix the error in the resource class to correctly include a custom attribute.

Laravel

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

Drag options to blanks, or click blank then click option'

Aadmin

BisAdmin

Cadmin_status

Dis_admin

Attempts:

3 left

💡 Hint

Common Mistakes

Using camelCase attribute names that don't exist on the model.

Using attribute names that are not defined in the model.

The attribute is_admin matches the typical Laravel model attribute naming for boolean flags.

4fill in blank

hard

Fill both blanks to add a conditional attribute to the resource output.

Laravel

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

Drag options to blanks, or click blank then click option'

Aphone !== null

Bphone

Cphone_number

Dphone != ''

Attempts:

3 left

💡 Hint

Common Mistakes

Using the wrong attribute name for the phone number.

Not providing a proper condition for the when method.

The when method conditionally includes the phone attribute only if it is not null.

5fill in blank

hard

Fill all three blanks to customize the resource response with additional data and a custom key.

Laravel

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

    public function with($request)
    {
        return [
            '[3]' => 'User data retrieved successfully',
        ];
    }
}

Drag options to blanks, or click blank then click option'

Ausername

Brole

Cmeta

Duser_name

Attempts:

3 left

💡 Hint

Common Mistakes

Using incorrect keys that don't match the data.

Not using the whenLoaded method properly.

The key user_name customizes the name field key, role is the relation to load, and meta adds extra info to the response.

Practice

1. What is the main purpose of an API Resource Class in Laravel?

easy

A. To manage user authentication

B. To handle database migrations

C. To format and control the data sent in API responses

D. To create views for web pages

Solution

1. Step 1: Understand the role of API Resource Classes

   API Resource Classes in Laravel are designed to transform data models into JSON responses for APIs.

2. Step 2: Identify what they do not do

   They do not handle database migrations, authentication, or view rendering.

3. Final Answer:

   To format and control the data sent in API responses -> Option C

4. Quick Check:

   API Resource Classes = Format API data [OK]

Hint: Remember: API Resource Classes shape API output data [OK]

Common Mistakes:

• Confusing resource classes with controllers
• Thinking resource classes handle database or auth
• Assuming resource classes create HTML views

2. Which of the following is the correct way to return a single resource in a Laravel controller using an API Resource Class named UserResource?

easy

A. return new UserResource($user);

B. return UserResource::collection($user);

C. return UserResource::makeCollection($user);

D. return UserResource::toJson($user);

Solution

1. Step 1: Recall syntax for returning a single resource

   To return a single model as a resource, you instantiate the resource class with the model: new UserResource($user).

2. Step 2: Understand collection syntax

   UserResource::collection($user) is for multiple models, not a single one.

3. Final Answer:

   return new UserResource($user); -> Option A

4. Quick Check:

   Single resource = new Resource($model) [OK]

Hint: Use 'new Resource($model)' for single items [OK]

Common Mistakes:

• Using collection() for single model
• Calling non-existent methods like makeCollection()
• Trying toJson() on resource class directly

3. Given the following Laravel API Resource class code, what will be the JSON output for a user with id=5 and name='Alice'?

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

// In controller:
return new UserResource($user);

medium

A. {"id":5,"name":"Alice"}

B. {"user_id":5,"user_name":"Alice"}

C. {"userId":5,"userName":"Alice"}

D. {"user_id":5,"name":"Alice"}

Solution

1. Step 1: Analyze the toArray method

   The method returns an array with keys 'user_id' and 'user_name' mapped to the model's id and name.

2. Step 2: Match output keys and values

   Given id=5 and name='Alice', the JSON keys and values must match exactly as defined.

3. Final Answer:

   {"user_id":5,"user_name":"Alice"} -> Option B

4. Quick Check:

   toArray keys = JSON keys [OK]

Hint: Match keys exactly as returned in toArray() [OK]

Common Mistakes:

• Assuming default keys like 'id' instead of 'user_id'
• Mixing camelCase and snake_case keys
• Ignoring the resource's toArray method

4. What is wrong with this Laravel API Resource class code snippet?

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

// In controller:
return ProductResource::collection($products);

medium

A. The code is correct and will return a collection of formatted products

B. Using ProductResource::collection is incorrect for multiple products

C. The controller should instantiate ProductResource with new keyword for collections

D. The toArray method should return a JSON string, not an array

Solution

1. Step 1: Check toArray method return type

   toArray should return an array, which Laravel converts to JSON automatically.

2. Step 2: Verify collection usage

   Using ProductResource::collection($products) is the correct way to return multiple resources.

3. Final Answer:

   The code is correct and will return a collection of formatted products -> Option A

4. Quick Check:

   collection() for multiple models = correct [OK]

Hint: Use ::collection() for multiple models, toArray returns array [OK]

Common Mistakes:

• Expecting toArray to return JSON string
• Using new keyword for collections
• Confusing single resource and collection syntax

5. You want to add a conditional field is_admin to your UserResource that only appears if the user has admin rights. Which is the best way to do this in the toArray method?

hard

A. Add 'is_admin' => $this->isAdmin() ? true : false, unconditionally

B. Return two different resource classes for admin and non-admin users

C. Add 'is_admin' only if $this->isAdmin() is true by overriding toResponse()

D. Use 'when' helper: 'is_admin' => $this->when($this->isAdmin(), true)

Solution

1. Step 1: Understand conditional fields in API Resources

   Laravel provides the 'when' helper to conditionally include fields in the response.

2. Step 2: Evaluate options

   Use 'when' helper: 'is_admin' => $this->when($this->isAdmin(), true) uses 'when' correctly to include 'is_admin' only if the user is admin.

3. Final Answer:

   Use 'when' helper: 'is_admin' => $this->when($this->isAdmin(), true) -> Option D

4. Quick Check:

   Use when() for conditional fields [OK]

Hint: Use when() helper to add fields conditionally [OK]

Common Mistakes:

• Always including the field even if false
• Overriding toResponse unnecessarily
• Creating separate resource classes for small condition