bestiony/laravel-api-response

A wrapper around Laravel response function that returns a consistent API response o failure or success

dev-main 2024-12-12 22:11 UTC

Requires

• php: ^8.1
• illuminate/http: ^8.0|^9.0|^10.0|^11.0|^12.0

MIT

• Abderrahman Fodili

README

A wrapper around Laravel response function that returns a consistent API response on failure or success.

Installation

composer require bestiony/laravel-api-response

Usage

In your controller or in the main Laravel controller, use the trait HasApiResponse:

namespace App\Http\Controllers;

use Bestiony\LaravelApiResponse\Traits\HasApiResponse;
use Illuminate\Http\Request;

class ExampleController extends Controller
{
    use HasApiResponse;

    public function index(Request $request)
    {
        $data = ['key' => 'value'];
        return $this->success(message:'Data retrieved successfully',data: $data);
    }

    public function errorExample(Request $request)
    {
        return $this->error(message:'An error occurred', code: 500);
    }
}

License

This package is open-sourced software licensed under the MIT license.