Skip to content

sem-feldoe/laravel-resource-index

Repository files navigation

Simple service to build api response for resource index

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.

About

Simple api resource index generator for laravel

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages