API resource classes in Laravel - Practice Problems & Coding Challenges

Challenge - 5 Problems

❓ component_behavior

intermediate

What is the output of this Laravel API Resource?

Given the following Laravel API Resource class, what will be the JSON output when returning new UserResource($user) where $user has id=5, name='Alice', and email='[e-mail]'?

Laravel

<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

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

A {"userId":5,"userName":"Alice","emailAddress":"[e-mail]"}

B {"user_id":5,"user_name":"Alice","contact":"[e-mail]"}

C [5,"Alice","[e-mail]"]

D {"id":5,"name":"Alice","email":"[e-mail]"}

💡 Hint

Look at the keys returned in the toArray method and match them with the output.

The toArray method defines the keys and values returned in the JSON. It renames the keys from the model's attributes to user_id, user_name, and contact.

❓ lifecycle

intermediate

When is the toArray method called in a Laravel API Resource?

In Laravel API Resource classes, at what point is the toArray method executed?

A Immediately when the resource object is created with <code>new</code>.

B Only when explicitly calling <code>toArray()</code> in the controller.

C When the resource is converted to JSON, such as when returned from a controller.

D When the resource is saved to the database.

💡 Hint

Think about when Laravel sends data to the browser or API client.

Laravel calls toArray automatically when the resource is serialized to JSON, such as when returning it from a controller or API route.

📝 Syntax

advanced

Which option correctly adds a conditional attribute in a Laravel API Resource?

You want to include the admin_notes attribute only if the user is an admin. Which code snippet inside toArray is correct?

A

return [
  'id' => $this->id,
  'name' => $this->name,
  'admin_notes' => $this->when($this->is_admin, $this->admin_notes),
];

B

return [
  'id' => $this->id,
  'name' => $this->name,
  'admin_notes' => $this->admin_notes if ($this->is_admin),
];

C

return [
  'id' => $this->id,
  'name' => $this->name,
  'admin_notes' => $this->is_admin ? $this->admin_notes : null,
];

D

return [
  'id' => $this->id,
  'name' => $this->name,
  'admin_notes' => $this->when($this->admin_notes, $this->is_admin),
];

💡 Hint

Use Laravel's when helper method correctly.

The when method takes a condition first, then the value to include if true. Option A uses it correctly.

🔧 Debug

advanced

Why does this Laravel API Resource return an empty JSON object?

Given this resource class, why does the API return {} instead of user data?

Laravel

<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

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

A The resource class must extend <code>ResourceCollection</code> instead of <code>JsonResource</code>.

B The resource class is missing the <code>JsonSerializable</code> interface implementation.

C The <code>$this->id</code> and <code>$this->name</code> properties are not accessible.

D The <code>toArray</code> method does not return the array; it just creates it without returning.

💡 Hint

Check if the toArray method returns the data.

Without a return statement, the method returns null, so Laravel outputs an empty JSON object.

🧠 Conceptual

expert

What is the main benefit of using Laravel API Resource classes?

Why should you use Laravel API Resource classes instead of returning Eloquent models directly in API responses?

A They allow you to control and customize the JSON structure and hide sensitive data easily.

B They automatically cache all API responses for better performance.

C They convert Eloquent models into XML format for API clients.

D They replace the need for database migrations and schema definitions.

💡 Hint

Think about data control and security in API responses.

API Resource classes let you shape the JSON output and exclude fields you don't want to expose, improving security and flexibility.