README

A Laravel helper to create uniform API responses

This package contains some useful helpers to return API responses in a uniform format.

Installation

You can install the package via composer:

composer require rickgoemans/laravel-api-response-helpers

Usage

use Rickgoemans\LaravelApiResponseHelpers\ApiResponse;

class ExampleController extends Controller {
    public function default(): JsonResponse {
        return ApiResponse::default([
            'message' => 'This is an example',
        ], 200);
    }
    
    public function success(): JsonResponse {
        return ApiResponse::success('Ths is an example', [
            'user_id' => 1,
            'name' => 'Rick Goemans',
        ], 200);
    }
    
    public function error(): JsonResponse {
        return ApiResponse::error('Invalid data', [
            'name' => [
                'required',
            ],
        ], 422);
    }
    
    public function unauthorized(): JsonResponse {
        return ApiResponse::unauthorized(401);
    }
    
    public function forbidden(): JsonResponse {
        return ApiResponse::forbidden(403);
    }
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

Rick Goemans

License

The MIT License (MIT). Please see License File for more information.

rickgoemans / laravel-api-response-helpers

Maintainers

Details