evgeny-l/rest-api-core

REST API Core. Handles REST API requests and responses.

v0.8.0 2022-03-10 11:37 UTC

Requires

• php: >=7.0
• laravel/framework: >5.3
• league/fractal: ^0.16.0

Requires (Dev)

• phpunit/phpunit: 5.*

MIT

• Evgeny Leksunin

• rest
• api
• laravel
• api-core

README

Install

Require this package with composer using the following command:

composer require evgeny-l/rest-api-core

After updating composer, add the service provider to the providers array in config/app.php

EvgenyL\RestAPICore\RestAPICoreServiceProvider::class,

Publish the config file to config/rest-api-core.php

php artisan vendor:publish --provider="EvgenyL\RestAPICore\RestAPICoreServiceProvider" --tag=config

Install exceptions handler to app/Exceptions/Handler.php:

use EvgenyL\RestAPICore\Http\Exceptions\APIJSONHandlerTrait;

...
    public function render($request, Exception $exception)
    {
        if ($request->expectsJson()) {
            return $this->handleJSONResponse($request, $exception);
        }
        return parent::render($request, $exception);
    }
    
...

Install response middleware for JSON formatting into API middleware section:

\EvgenyL\RestAPICore\Http\Middleware\ResponseFormat::class