Withable Laravel Package

Product Decisions This Supports

• Dynamic API/Backend Flexibility: Enables developers to expose granular control over eager-loaded relationships via query parameters, reducing frontend complexity and improving performance by avoiding N+1 queries.
• Roadmap for API-Driven Features: Supports future plans for self-service data fetching (e.g., admin dashboards, third-party integrations, or headless CMS) where clients need to specify related data dynamically.
• Build vs. Buy: Avoids reinventing eager-loading logic, saving dev time while maintaining consistency with Laravel’s conventions.
• Use Cases:
  • Admin Panels: Let admins toggle nested data (e.g., ?with=users,posts,comments).
  • Public APIs: Enable clients to request only the data they need (e.g., ?with=author,tags).
  • Performance Optimization: Reduce over-fetching in complex queries by letting consumers specify relationships.

When to Consider This Package

• Adopt if:
  • Your Laravel app uses Eloquent models with nested relationships that need dynamic eager-loading.
  • You’re building an API or admin interface where clients/developers should control data depth.
  • You prioritize developer velocity over custom solutions (e.g., manual with() logic in controllers).
  • Your team is already using Laravel 4–6 (compatibility is limited to these versions).
• Look elsewhere if:
  • You need real-time filtering/sorting alongside eager-loading (consider Pimpable or building a custom solution).
  • Your app uses Laravel 7+ (package is unmaintained; check for forks or alternatives like spatie/laravel-query-builder).
  • You require complex relationship conditions (e.g., conditional with() clauses) beyond simple string matching.
  • Security is a concern: The package lacks input validation by default (you’ll need to sanitize with parameters manually).

How to Pitch It (Stakeholders)

For Executives: "This package lets our backend dynamically serve nested data based on client requests—like a ‘choose-your-own-adventure’ for API responses. For example, an admin could fetch a Post with its author and comments by simply appending ?with=author,comments to the URL. This reduces frontend work, cuts unnecessary data transfer, and future-proofs our APIs for third-party integrations. It’s a low-risk, high-reward way to add flexibility without reinventing the wheel."

For Engineering: "The Withable trait lets us declaratively expose eager-loading via query params, cutting boilerplate in controllers. For a model like Post, we define allowed relations (e.g., ['author', 'tags']), and the package handles the rest. It’s lightweight, Laravel-native, and integrates seamlessly with existing Eloquent queries. Tradeoffs:

• No built-in validation (add middleware to sanitize with params).
• Limited to Laravel 4–6 (but works for most legacy apps).
• Pair with Pimpable if you also need sorting/filtering.

Example use case: Replace Post::with(['author', 'comments'])->get() with Post::with(Request::input('with'))->get() in your API routes."