PHP code example of mahmoud-almalah / laravel-api-helpers
1. Go to this page and download the library: Download mahmoud-almalah/laravel-api-helpers library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
mahmoud-almalah / laravel-api-helpers example snippets
use MahmoudAlmalah\LaravelApiHelpers\Responses\ApiResponse;
public function index()
{
return ApiResponse::success(
data: ['foo' => 'bar'],
message: 'Operation successful'
);
}
use MahmoudAlmalah\LaravelApiHelpers\Responses\ApiResponse;
use Symfony\Component\HttpFoundation\Response;
public function error()
{
return ApiResponse::error(
message: 'Something went wrong',
status: Response::HTTP_BAD_REQUEST
);
}
use MahmoudAlmalah\LaravelApiHelpers\Responses\ApiResponse;
use App\Http\Resources\UserResource;
public function show(User $user)
{
return ApiResponse::model(
key: 'user',
resource: new UserResource($user),
message: 'User retrieved successfully'
);
}
use MahmoudAlmalah\LaravelApiHelpers\Responses\ApiResponse;
use App\Http\Resources\UserResource;
public function index()
{
$users = User::paginate(10);
return ApiResponse::collection(
key: 'users',
resource: UserResource::collection($users),
paginator: $users,
message: 'Users list'
);
}
use Illuminate\Foundation\Configuration\Exceptions;
use Illuminate\Http\Request;
use MahmoudAlmalah\LaravelApiHelpers\Exceptions\ApiExceptionHandler;
->withExceptions(function (Exceptions $exceptions) {
$exceptions->render(function (\Throwable $e, Request $request) {
if ($request->is('api/*') || $request->expectsJson()) {
return ApiExceptionHandler::render($e);
}
});
})