php 43 lines · 8 steps

Filtered, paginated JSON APIs in Laravel

An Eloquent query builder collects filters conditionally, then an API Resource shapes each row into clean JSON.

Explained by highlit

Laravel Intermediate eloquent query-builder api-resources pagination eager-loading

1class PostController extends Controller
2{
  public function index(Request $request): AnonymousResourceCollection
  {
      $posts = Post::query()
          ->with(['author', 'tags'])
          ->withCount('comments')
          ->when($request->filled('search'), function ($query) use ($request) {
              $query->where('title', 'like', "%{$request->string('search')}%");
          })
          ->when($request->filled('tag'), function ($query) use ($request) {
              $query->whereHas('tags', fn ($q) => $q->where('slug', $request->string('tag')));
          })
          ->latest('published_at')
          ->paginate($request->integer('per_page', 15))
          ->withQueryString();
17 
      return PostResource::collection($posts);
  }
20}
21 
22class PostResource extends JsonResource
23{
  public function toArray(Request $request): array
  {
      return [
          'id' => $this->id,
          'title' => $this->title,
          'slug' => $this->slug,
          'excerpt' => Str::limit(strip_tags($this->body), 160),
          'comments_count' => $this->comments_count,
          'author' => [
              'name' => $this->author->name,
              'avatar_url' => $this->author->avatar_url,
          ],
          'tags' => $this->tags->pluck('name'),
          'published_at' => $this->published_at?->toIso8601String(),
          'links' => [
              'self' => route('posts.show', $this->slug),
          ],
      ];
  }
43}

01 / 01

STEP 01

Walkthrough

Space play ←→ step click any line

Three takeaways

1Conditional query methods like when() let you build filters from request input without scattering if-statements.
2Eager loading with with() and withCount() prevents N+1 queries when the response touches related records.
3API Resources separate database shape from response shape, giving you a stable, deliberate JSON contract.

Related explainers

php

<?php
 
namespace App\Console\Commands;

Releasing stale document locks in Laravel

artisan-command transactions row-locking

Intermediate 6 steps

php

<?php
 
namespace App\Providers;

Subdomain multi-tenancy routing in Laravel

multi-tenancy service-container route-binding

Advanced 7 steps

ruby

module Paginatable
  extend ActiveSupport::Concern
 
  private

A reusable pagination concern in Rails

pagination concerns http-headers

Intermediate 8 steps

php

<?php
 
namespace App\Broadcasting;

Authorizing presence channels in Laravel

broadcasting authorization presence-channels

Intermediate 3 steps

php

<?php
 
namespace App\Http\Middleware;

Resolving the current team in Laravel middleware

middleware multi-tenancy cookies

Intermediate 8 steps

php

<?php
 
namespace App\Http\Controllers;

Broadcasting typing indicators in Laravel

websockets authorization presence-channels

Intermediate 9 steps

Share this explainer

Here's the card — post it anywhere.

Filtered, paginated JSON APIs in Laravel — share card

Made with highlit — turn any snippet into a walkthrough like this in about a minute.

Explain your code