freepeace/larabone

Personal laravel extension package for creating APIs

dev-master 2019-06-20 06:40 UTC

Requires

• php: ^7.1.3
• illuminate/database: 5.8.*
• illuminate/support: 5.8.*

Requires (Dev)

• orchestra/testbench: ^3.8
• phpunit/phpunit: ^7.0

MIT

• Kin Basco

• larabone

README

Personal laravel extension package for creating APIs.

• Installation
• Exceptions
• Helpers

Installation

You can install the package via composer:

composer require --prefer-dist freepeace/larabone

Exceptions

Package contain three built-in exceptions:

• NotFoundException (404)
• ForbiddenException (403)
• UnauthorizedException (401)

But you can freely create you own exceptions by extending APIException class.

Example:

<?php

namespace App\Exceptions;

use Freepeace\Larabone\Exceptions\APIException;

class ServerErrorException extends APIException
{
    public function __construct(string $message = null, array $headers = [])
    {
        parent::__construct(500, $message, null, $headers);
    }
}

Usage:

20:     throw new \App\Exceptions\ServerErrorException('Oops! Something went wrong.');

The above example will have JSON response of:

# Debug = true
{
    "message": "Oops! Something went wrong",
    "debug": {
        "exception": "App\Exceptions\ServerErrorException",
        "file": "path-to-file-where-exception-is-thrown",
        "line":  20
    }
}
# Debug = false
{
    "message": "Oops! Something went wrong."
}

DO NOT FOGET to call APIException::responder function in you exception handler. Edit your App\Exceptions\Handler class on render function:

<?php

namespace App\Exceptions;

use Freepace\Larabone\Exceptions\APIException;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;

class Handler extends ExceptionHandler
{
    public function render($request, Exception $exception)
    {
        if ($request->ajax()) {
            return APIException::responder($request, $exception);
        }

        return parent::render($request, $exception);
    }
}