README

A professional, production-ready Laravel package to standardize your API JSON responses. Developed by Maksudur Rahman.

Features

PSR-4 Compliant: Clean, object-oriented structure.
Multiple Usage Patterns: Use Facades, Traits, or Global Helpers.
Fully Configurable: Customize response keys (status, message, data, etc.) to match your needs, including status_code/status_message.
Standardized Pagination: Automatic formatting for Laravel's Paginator.
Zero Configuration: Works out of the box, but highly customizable.
Compatible: Supports Laravel 8, 9, 10, 11, 12, and 13.

Installation

You can install the package via composer:

composer require maksudur-dev/laravel-api-response

Configuration (Optional)

If you want to customize the response keys, publish the config file:

php artisan vendor:publish --provider="Maksudur\ApiResponse\ApiResponseServiceProvider" --tag="config"

This will create a config/api-response.php file where you can change the keys:

'keys' => [
    'status' => 'status', // e.g., change 'status' to 'status_code'
    'message' => 'message', // e.g., change 'message' to 'status_message'
    'data' => 'data',
    'errors' => 'errors',
    'pagination' => 'pagination',
],

For example, you can customize your response fields to use status_code and status_message instead of the default status and message keys.

Usage

1. Using Facade (Recommended)

use ApiResponse;

return ApiResponse::success($data, 'User created', 201);
return ApiResponse::error('Invalid credentials.', null, 400);
return ApiResponse::paginate($users, 'Success', 200);

2. Using Trait (Best for Controllers)

Add the HasApiResponse trait to your controller:

use Maksudur\ApiResponse\Traits\HasApiResponse;

class UserController extends Controller
{
    use HasApiResponse;

    public function index()
    {
        $users = User::paginate(10);
        return $this->apiPaginate($users);
    }
}

3. Using Global Helpers

return api_success($data);
return api_error('Invalid input');
return api_paginate($paginator);

Response Formats

Success Response

{
  "status": 100,
  "message": "Success",
  "data": { ... }
}

Error Response

{
  "status": 400,
  "message": "Error",
  "errors": { ... }
}

Pagination Response

{
  "status": 100,
  "message": "Success",
  "data": [ ... ],
  "pagination": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 10,
    "total": 50
  }
}

Custom Key Response

If you change the config keys, your JSON response can instead use names like status_code and status_message:

{
  "status_code": 100,
  "status_message": "Success",
  "data": [ ... ],
  "pagination": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 10,
    "total": 50
  }
}

License

The MIT License (MIT). Please see License File for more information.

maksudur-dev / laravel-api-response

Maintainers

Package info

Statistics

Security