README

Automatically generate query parameters based on Eloquent Models

Features

This package provides automatic rules and a builder for query parameters to be used in GET routes for index requests.
This includes rules generation and a query builder.
The available parameter operations are:

Filters – equal, not equal, less than, and many others.
Sorting – ascending and descending.
Fields – fields to be included in the response.
Includes – nested relations to be included in the response.
Pagination – page limit and page number.

Installation

composer require victormgomes/query-params

Usage

Rules generation

First, use the Rules::generate method to inject the automatic query parameter rules into the rules of the desired class that extends a FormRequest.
You must also provide a fully qualified class name (FQCN) as an argument, for example:

//app/Http/Requests/Users/UserIndexRequest.php
<?php

namespace App\Http\Requests\Users;

use App\Models\User\User;
use Illuminate\Foundation\Http\FormRequest;
use Victormgomes\Queryparams\Rules;

class UserIndexRequest extends FormRequest
{
    public function rules(): array
    {
        $rules = Rules::generate(User::class);

        return $rules;
    }
}

Now the rules for your query parameters can handle incoming requests,
and can also be automatically described in OpenAPI documentation with tools like Scramble or Swagger.
Additionally, you can import the OpenAPI JSON into tools like Postman to see all possible query parameters.

The rules will look like this:

Query Builder

In the index method of the controller, use the UserIndexRequest class as the type of the incoming request.
Then, use the QueryBuilder::build method to build the query for the model,
passing the FQCN of the model and the request as arguments:

//app/Http/Controllers/User/UserController.php
<?php

namespace App\Http\Controllers\User;

use App\Http\Controllers\Controller;
use App\Http\Requests\Users\UserIndexRequest;
use App\Models\User\User;
use Victormgomes\Queryparams\QueryBuilder;

class UserController extends Controller
{
    public function index(UserIndexRequest $request): JsonResponse
    {
        $users = QueryBuilder::build(User::class, $request);

        return response()->json([
            'status' => 'success',
            'data' => $users,
        ], 200);
    }
...
}

Now you can make requests based on the generated rules.

Many other improvements coming soon

Thanks!

victormgomes / query-params

Maintainers

Details