feldoe/laravel-resource-index

Simple service to build api response for resource index

v1.6.1 2025-04-01 14:58 UTC

Requires

• php: ^8.1
• illuminate/database: ^9.0|^10.0|^11.0|^12.0
• illuminate/http: ^9.0|^10.0|^11.0|^12.0
• illuminate/support: ^9.0|^10.0|^11.0|^12.0

Requires (Dev)

• nunomaduro/larastan: ^2.0
• orchestra/testbench: ^7.16
• phpstan/extension-installer: ^1.2.0

MIT

• Nicolas DENIAUD

• feldoe
• laravel-resource-index

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')

License

Laravel resource index is open-sourced software licensed under the MIT license.