feldoe / laravel-resource-index
Simple service to build api response for resource index
Package info
github.com/sem-feldoe/laravel-resource-index
pkg:composer/feldoe/laravel-resource-index
Requires
- php: ^8.1
- illuminate/database: ^9.0|^10.0|^11.0|^12.0|^13.0
- illuminate/http: ^9.0|^10.0|^11.0|^12.0|^13.0
- illuminate/support: ^9.0|^10.0|^11.0|^12.0|^13.0
Requires (Dev)
- larastan/larastan: ^3.0
- orchestra/testbench: ^10.0|^11.0
- phpstan/extension-installer: ^1.4
Suggests
- laravel/wayfinder: Optional TypeScript response generation for endpoints using ResourceIndexResponse.
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-13 14:04:04 UTC
README
About laravel resource index
Example
use Atx\ResourceIndex\Contracts\ResourceIndex; use Illuminate\Routing\Controller; use Illuminate\Http\JsonResponse; use Illuminate\Http\Request; class Index extends Controller { public function __invoke(Request $request, ResourceIndex $service): JsonResponse { return $service->from(MyModel::class, MyModelResource::class) ->processRequest( $request, // Filterable [ 'filterable_column', ], // Searchable [ 'searchable_column', ], // Sortable [ 'sortable_column', ] ) ->response(); } }
Front usage example
fetch('http://localhost/api/v1/endpoint?filter[filter1][]=test&filter[filter2]=true&sort=-created_at&search=test')
Optional Wayfinder integration
Existing from(Model::class, Resource::class) calls remain supported. Applications
with a custom implementation or override of the ResourceIndex interface must also
make the resource argument nullable and optional to match the updated contract.
To expose the resource to Wayfinder, declare it once on the controller method:
use Atx\ResourceIndex\Attributes\ResourceIndexResponse; #[ResourceIndexResponse(MyModelResource::class)] public function __invoke(Request $request, ResourceIndex $service): JsonResponse { return $service->from(MyModel::class) ->processRequest($request) ->additional(['summary' => ['label' => 'Example']]) ->response(); }
The attribute is declared on the controller method. Its resource is used both at
runtime and during generation.
Declaring both the attribute and the resource argument to from() throws a
LogicException, even when they refer to the same class. Omitting both also throws.
An explicit request can be passed as from(MyModel::class, request: $request).
No additional registration is required when Wayfinder is installed. The integration uses Ranger's route hook and Surveyor's resource analyzer. Wayfinder is optional: normal HTTP responses continue working without the development dependency.
The generated response describes item fields from the JsonResource. Pagination
meta and links are optional records because pagination and additional data can
vary per request. Arbitrary fields added by additional() are preserved at runtime
but are not inferred. On attributed listings, additional() cannot set data,
which is reserved for the declared collection. Legacy calls retain their previous
additional() behavior. Global JsonResource::withoutWrapping() is supported.
The initial integration supports item JsonResources. Custom ResourceCollection inference is rejected explicitly during generation instead of emitting a misleading type. Accuracy of nested resources and conditional fields also depends on the installed Wayfinder/Surveyor versions. No vendor patches are installed by this package.
Tests
vendor/bin/phpunit -c phpunit.xml.dist
Core tests use an in-memory SQLite database. Wayfinder adapter tests are skipped when the optional dependencies are absent.
License
Laravel resource index is open-sourced software licensed under the MIT license.