luciano-jr/laravel-api-query-handler

Laravel API Query Handler Package.

Laravel API query handler

, _(*1)

This Laravel package helps to handle a query request properly, _(*2)

Synopsis

In order to help, _(*3)

Code Example

Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise., _(*4)

Motivation

A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists., _(*5)

Installation

Require this package with composer using the following command:, _(*6)

composer require luciano-jr/laravel-api-query-handler

After updating composer, add the service provider to the providers array in config/app.php, _(*7)

LucianoJr\LaravelAPIQueryHandler\Providers\LaravelApiQueryHandlerServiceProvider::class,

Configuration File

If you use Lumen please skip this step, _(*8)

If you want to change the default parameters, run this command on the terminal in order to publish the vendor config file:, _(*9)

php artisan vendor:publish --provider="Lucianor\LaravelApiQueryHandler\Providers\LaravelApiQueryHandlerServiceProvider", _(*10)

Usage

    public function index(Request $request)
    {
        $collection = $this->repository->all();

        $collectionHandler = new CollectionHandler($collection, $request);
        $collectionHandler->handle();
    }

Tests

Describe and show how to run the tests with code examples., _(*11)

Contributors

Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable., _(*12)

License

The Laravel API query handler is open-sourced software licensed under the MIT license., _(*13)