A package to provide some standardized response classes.
This package supports Laravel 6, 7, 8 and 9 but requires at least PHP 8.0. PHP 7.4 is supported up to version 2.1.1.
Via Composer
$ composer require egeatech/laravel-responsesSimply return a new instance of either ApiResponse or PaginatedApiResponse from your controller method.
Both classes share a similar signature for their constructors:
Here is the constructor for ApiResponse:
public function __construct(
# Either null, a valid Eloquent model or an \Illuminate\Support\Collection instance or a generic payload
mixed $responseData,
# A classFQN extending Laravel JsonResource instance, to be used to know how to map response data. Can be null if data don't need formatting.
?string $responseFormatter,
# A valid HTTP status code, to be returned to the caller
int $httpStatus = \Illuminate\Http\JsonResponse::HTTP_OK,
# An optional ApplicationException instance, to properly provide a valid error message representation
?\EgeaTech\LaravelExceptions\Interfaces\Exceptions\LogicErrorException $logicException = null
) {}And here the one for PaginatedApiResponse class:
public function __construct(
# A standard Laravel paginator instance, holding both data and pagination information
\Illuminate\Contracts\Pagination\LengthAwarePaginator $paginatorData,
# A classFQN extending Laravel JsonResource instance, to be used to know how to map response data
string $responseFormatter,
# A valid HTTP status code, to be returned to the caller
int $httpStatus = \Illuminate\Http\JsonResponse::HTTP_OK,
# An optional ApplicationException instance, to properly provide a valid error message representation
?\EgeaTech\LaravelExceptions\Interfaces\Exceptions\LogicErrorException $logicException = null
) {}An example usage for the ApiResponse class could be the following:
<?php
namespace App\Http\Controllers\Api\TestController;
use App\Http\Controllers\Controller;
use App\Http\Requests\ModelUpdateRequest;
use EgeaTech\LaravelResponses\Http\Responses\ApiResponse;
use EgeaTech\LaravelExceptions\Interfaces\Exceptions\LogicErrorException;
class TestController extends Controller
{
public function __invoke(ModelUpdateRequest $request): ApiResponse
{
$occurredException = null;
$databaseModel = null;
try {
$modelData = $request->validated();
$databaseModel = $this->updateModel($modelData);
} catch (LogicErrorException $exception) {
$occurredException = $exception;
}
return new ApiResponse(
$databaseModel,
DatabaseModelResource::class,
$occurredException
? $occurredException->getCode()
: ApiResponse::HTTP_ACCEPTED,
$occurredException
);
}
}For the other class, its usage is the same as long as you provide a LenghtAwarePaginator instance as first parameter.
Please see the CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email author email instead of using the issue tracker.
The software is licensed under MIT. Please see the LICENSE file for more information.