README

Consistent JSON API response helpers for Laravel applications.

Laravel API Response wraps every JSON response in a standard { success, message, data, errors, meta } envelope. Helper functions, a facade, response macros, and a fluent builder give you multiple ways to produce the same consistent output from controllers, jobs, middleware, or anywhere in your application.

The package is intentionally small and does not manage routing, authentication, or business logic. It formats the response body that moves through those layers.

Highlights

• Return success and error responses with a single method call.
• Standard { success, message, data, errors, meta } envelope on every response.
• Wrap JsonResource, ResourceCollection, and paginated results automatically.
• Build complex responses step by step with the fluent builder.
• Use the api_response() helper, api() shortcut, ApiResponse facade, or Response:: macros.
• Add static or dynamic root-level fields to every response.
• Localize default messages via Laravel translation files.
• Opt in to automatic exception rendering for common Laravel exceptions.
• Configure macro names, collision behavior, and exception exposure.

Requirements

Installation

composer require satheez/laravel-api-response

Optionally publish the config and translations:

php artisan vendor:publish --tag="api-response-config"
php artisan vendor:publish --tag="api-response-translations"

See Installation for the full setup flow.

Quick Start

use App\Http\Requests\StoreUserRequest;
use App\Http\Resources\UserResource;
use App\Models\User;
use Illuminate\Http\JsonResponse;

final class UserController
{
    public function store(StoreUserRequest $request): JsonResponse
    {
        $user = User::query()->create($request->validated());

        return api_response()->created(
            data: new UserResource($user),
            message: 'User created successfully.',
        );
    }

    public function show(User $user): JsonResponse
    {
        return api_response()->success(new UserResource($user));
    }

    public function destroy(User $user): JsonResponse
    {
        $user->delete();

        return api_response()->deleted();
    }
}

Equivalent response styles:

api_response()->success(['status' => 'ok']);   // Helper
api()->error('Invalid request');                // Shorter alias
ApiResponse::created(['id' => 1]);              // Facade
Response::success(['status' => 'ok']);           // Macro
response()->error('Invalid request');            // Macro via helper

Response Envelope

Every response uses the same base structure:

{
    "success": true,
    "message": "Request completed successfully.",
    "data": null,
    "errors": null,
    "meta": []
}

Available Methods

Documentation

Contributing

See CONTRIBUTING.md for local setup, coding standards, and pull request guidelines.

Changelog

All notable changes are documented in CHANGELOG.md.

Testing This Package

composer test
composer test-coverage
composer analyse
composer format-test

License

Laravel API Response is open-sourced software licensed under the MIT license.