eborio / laravel-responses
Unified responses format for Laravel projects
Installs: 229
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:project
Requires
- php: ^8.2
- eborio/laravel-gettext: ^8.0
Requires (Dev)
- phpunit/phpunit: ^12.3
README
This is the official documentation for the Laravel Responses package, a unified JSON response helper for Laravel projects.
Table of Contents
- Installation - How to install and set up the package
- Quick Start - Basic usage examples
- Usage Guide - Detailed usage patterns and examples
- Configuration - Configuration options and customization
- API Reference - Complete API documentation
- Testing - Testing guide and coverage information
- Contributing - How to contribute to the project
Overview
Laravel Responses provides a standardized way to create consistent JSON API responses in Laravel applications. The package offers multiple interfaces:
- Global helper functions for quick response creation
- ResponseFactory macros for fluent response building
- Static factory methods on the Responses class for programmatic use
All response methods follow the same JSON structure:
{ "status": "OK|ERROR|FAILED", "code": 200, "message": "Success message", "data": {} }
Quick Example
use Eborio\LaravelResponses\Responses; // Using static methods return Responses::ok(['user' => $user]); // Using helpers return laravel_responses_ok(['user' => $user]); // Using response macros return response()->ok(['user' => $user]);
License
This project is licensed under the MIT License - see the LICENSE file for details.