README

This package simplifies creating api (json) endpoints for your laravel application by reducing routing, authorization, validation and controller logic to a single class.

class UserReadAction extends ActionController
{
    public function method(): string 
    {
        return 'GET';
    }

    public function uri(): string 
    {
        return '/users/{user}';
    }

    public function allow(Request $request): bool 
    {
        return true;
    }

    public function rules(Request $request): array 
    {
        return [];
    }

    public function handle(User $user): User
    {
        return $user;
    }
}

This will action will

register a GET-Route for /users/{user}
authorizes request
validates request
handle logic

Installation

Via Composer

$ composer require kaydomrose/laravel-api-action

Usage

First, create an action via artisan command.

$ php artisan make:action MyAction

This creates a new class app/Http/Actions/MyAction.php.

Next, register your action in your routes/api.php

LaravelApiAction::routes([
    MyAction::class,
]);

Done!

Documentation

Routing (required)

public function method(): string {
    return 'GET';
}

public function uri(): string {
    return '/users/{user}';
}

Specify http verb and uri for your action.
See https://laravel.com/docs/master/routing#available-router-methods for available verbs.

Above example will be translated to

Route::get('/users/{user}', /* ... */);

Authorization (required)

    public function allow(Request $request): bool 
    {
        return true;
    }

Check whether the current request is authorized or not.
Works just like form request authorization.

Validation (required)

    public function rules(Request $request): array 
    {
        return [];
    }

Specify rules for request validation as seen in form builder validation.

Handle (required)

    public function handle() {
        /* Your logic */
    }

This is where you put your action logic, just like you would normally do in your controller.
Also supports dependency injection and route model binding.

Your return value will be wrapped with response()->json(), so don't wrap it yourself.
Just return raw data.

Customize http status (optional)

    public function responseStatusCode(): int {
        return 200;
    }

Customize response status code.
Default is 200.

Customize validation messages (optional)

    public function validationMessages(): array {
        return [];
    }

Customize validation error messages.
Default is [].

Change log

Please see the changelog for more information on what has changed recently.

Testing

$ composer test

kaydomrose / laravel-api-action

Maintainers

Details