API resource classes in Laravel - Performance & Optimization

Performance: API resource classes

MEDIUM IMPACT

API resource classes affect the server response time and the size of JSON payloads sent to the client, impacting page load speed and interaction responsiveness.

Transforming Eloquent models to JSON for API responses

Laravel

return new UserResource($user);

Only selected attributes are serialized, reducing payload size and serialization overhead.

📈 Performance GainSaves 50-150kb in response size, reduces server CPU time, improves LCP by 100ms+

Transforming Eloquent models to JSON for API responses

Laravel

return response()->json($user->toArray());

Returns all model attributes including unnecessary data, increasing payload size and serialization time.

📉 Performance CostAdds unnecessary kilobytes to response, increasing LCP by 100-200ms on slow networks

Performance Comparison

Pattern	Payload Size	Server CPU	Network Transfer	Verdict
Raw Model to JSON	Large (all attributes)	High (full serialization)	High (large JSON)	[X] Bad
API Resource Class	Small (selected fields)	Low (optimized serialization)	Low (smaller JSON)	[OK] Good

Rendering Pipeline

API resource classes affect the server-side serialization stage before the browser receives data. Smaller, optimized JSON reduces network transfer time and speeds up browser rendering of content.

→Server Serialization

→Network Transfer

→Browser Parsing

⚠️ BottleneckServer Serialization and Network Transfer

Core Web Vital Affected

LCP

API resource classes affect the server response time and the size of JSON payloads sent to the client, impacting page load speed and interaction responsiveness.

Optimization Tips

1Use API resource classes to send only necessary data fields.

2Avoid returning raw models directly to reduce payload size.

3Paginate large collections and use resource collections for better performance.

Performance Quiz - 3 Questions

How do API resource classes improve page load speed?

A By increasing the number of database queries

B By reducing JSON payload size and serialization time on the server

C By caching the entire API response on the client

D By adding more data fields to the response

DevTools: Network

How to check: Open DevTools, go to Network tab, filter API requests, inspect response size and timing.

What to look for: Look for smaller response payload size and faster time to first byte indicating efficient resource usage.

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