README

A minimal, reusable REST API toolkit for Laravel.

Namespace: HafizMMoaz\RestApi

Provides:

• ApiResponse — ApiResponse::success($data, $message) / ApiResponse::error($message, $status, $code, $details) for consistent JSON envelopes.
• A typed exception hierarchy under HafizMMoaz\RestApi\Exceptions — ApiException (base) plus ResourceNotFoundException, RelatedResourceNotFoundException, ValidationException, UnauthorizedException, UnauthenticationException. Each carries an HTTP status code and renders to a JSON error response.
• ApiModel / ApiController — thin base classes to group API resources/endpoints.

Installation

composer require hafizmmoaz/laravel-rest-api

The service provider HafizMMoaz\RestApi\Providers\ApiServiceProvider is auto-discovered. It registers a renderer so any thrown ApiException is returned as its JSON error response automatically.

Usage

use HafizMMoaz\RestApi\ApiResponse;
use HafizMMoaz\RestApi\Exceptions\ResourceNotFoundException;

return ApiResponse::success($user, 'OK');

throw new ResourceNotFoundException('User not found');

License

MIT — see LICENSE.