foothing/laravel-repository-controller

Resources controller with Eloquent Laravel Repository implementation.

Laravel Repository Controller

Easily open an HTTP api over your Laravel database., _(*1)

Setup

Install with composer:, _(*2)

composer require foothing/laravel-repository-controller, _(*3)

This package will define several routes in a REST-like format that will perform operations on your database., _(*4)

Add the service provider in config/app.php:, _(*5)

    "providers" => [

        Foothing\RepositoryController\RepositoryControllerServiceProvider::class,

    ],

In order to enable the routes, you'll need to declare them in your routes.php:, _(*6)

    // ... your app routes

    RouteInstaller::install('api/v1/');

Be careful and place the RouteInstaller::install() method at the very end of your routes.php in order to avoid conflicts., _(*7)

IMPORTANT: you will need to change the default Controllers namespace in RouteServiceProvider like so: protected $namespace = '';, _(*8)

Finally, configure your resources in the config file., _(*9)

php artisan vendor:publish --provider="Foothing\RepositoryController\RepositoryControllerServiceProvider" --tag="config"

This will add the resources.php file in your config folder., _(*10)

'resources' => array(

    // Resources must be in the form 'resourceName' => 'resourceImplementation'
    // The implementation should be a fully qualified namespace to the model.

    'user' => 'App\User',
    'foo'  => 'My\Namespace\Foo',
),

This will enable the routes on the specified resources., _(*11)

How to use

The RouteInstaller will declare the package routes. You can specify a prefix as an optional install() argument. The process will enable the following routes, which we'll describe in better details later., _(*12)

Each api endpoint will return data in JSON format., _(*13)

Read resources

Examples, _(*14)

• GET api/v1/resources/user: will return all users
• GET api/v1/resources/user/15: will return user with id = 15
• GET api/v1/resources/user/15/roles will return user 15 roles

Pagination, _(*15)

This endpoint will handle 2 querystring args for pagination: - page (pagination page) - ipp (pagination items-per-page), _(*16)

The result will be a Laravel paginated result like:, _(*17)

{
    "total":4,
    "per_page":"25",
    "current_page":1,
    "last_page":1,
    "next_page_url":null,
    "prev_page_url":null,
    "from":1,
    "to":4,
    "data":[ the resources array ]
}

Related resources, _(*18)

You can pass an optional with query string argument that will be used to fetch relations within the requested resource:, _(*19)

GET api/v1/resources/user/1?with=roles,posts, _(*20)

Auto eager loading relations, _(*21)

Since this package relies on Laravel Repository you can take advantage of that package eager loading features therefore enabling auto eager-load features on each resource., _(*22)

Create resources

Create the requested resource., _(*23)

Example, _(*24)

POST api/v1/resources/user, _(*25)

POST payload, _(*26)

{
    name: 'foo',
    email: 'foo@bar.baz'
}

HTTP Response, _(*27)

{
    id: 1,
    name: 'foo',
    email: 'foo@bar.baz'
}

Update resources

Update the requested resource., _(*28)

Example, _(*29)

PUT api/v1/resources/user/1, _(*30)

PUT payload, _(*31)

{
    id: 1,
    name: 'updating name',
    email: 'foo@bar.baz'
}

HTTP Response, _(*32)

{
    id: 1,
    name: 'updating name',
    email: 'foo@bar.baz'
}

Delete resources

Delete the requested resource., _(*33)

Example, _(*34)

DELETE api/v1/resources/user/1, _(*35)

Link, bulk create and bulk update

More info coming soon., _(*36)

LICENSE

MIT, _(*37)