payamowow / laravel-resources

A package to create projects faster

Laravel Resources

Create api endpoints with ease.

Route registration

This package adds a few new features to the already existing apiResource method, model and requests.

model will be used to determine what model is being be handled.
requests should contain the form requests that are used to validate incoming data during creation and updating.

Example:

use App\Http\Requests\Posts\StoreRequest;
use App\Http\Requests\Posts\UpdateRequest;
use App\Models\Post;
use OwowAgency\LaravelResources\Controllers\ResourceController;

Route:apiResource(
    'posts',
    ResourceController::class,
    [
        'model' => Post::class,
        'requests' => [
            'store' => StoreRequest::class,
            'update' => UpdateRequest::class,
        ],
    ],
);

Customizing controllers

All methods in the ResourceController can be overwritten. We made it a little easier by adding methods like indexModel, and updateModel. You will not have to worry about validating, authorization, or returning the models as response.

use OwowAgency\LaravelResources\Controllers\ResourceController;

class PostController extends ResourceController
{
    /**
     * Returns models instances used for the index action.
     * 
     * @return mixed
     */
    public function indexModel()
    {
        return Post::where('title', 'LIKE', request('search'))->paginate();
    }

    /**
     * Updates and returns the model instance for the update action.
     * 
     * @param  \Illuminate\Http\Request  $request
     * @param  \Illuminate\Database\Eloquent\Model  $model
     * @return void
     */
    public function updateModel(Request $request, Model $model)
    {
        $model->update(['user_id' => \Auth::user()->id]);
    }
}

Eloquent API resources

This package will always try to return the API resource representation of the specified model. It applies auto discovery to determine what resource to use.

By default it will use the following pattern to discover the resource class:

App\Http\Resources\{class_baseName($modelClass)}Resource

In case of a Post model that will become:

App\Http\Resources\PostResource

Configuration

Configuration can be published with:

php artisan vendor:publish --tag=laravelresources

return [

    /**
     * Is used for auto discovery of http resources. Allows for placing
     * resources under a different namespace.
     */
    'resource_namespace' => 'App\\Http\\Resources',

    /**
     * Configure resources that do not follow the default auto discovery rules.
     * 
     * Eg:
     * [Post::class => SpecialPostResource::class]
     */
    'resource_factory' => [],

];