Download the PHP package anyo-lab/api-response without Composer

Laravel API Response

A comprehensive Laravel package for universal API response and error handling. This package provides a standardized way to format API responses and handle exceptions in Laravel applications with multiple usage patterns and advanced features.

🚀 Features

• 🎯 Standardized API Responses - Consistent response format across your entire API
• 🛡️ Automatic Exception Handling - Custom exception handler for API routes
• 📝 Multiple Usage Methods - Use as service, trait, facade, macros, or helper functions
• ⚙️ Highly Configurable - Customize response structure and messages
• 📊 Built-in Pagination - Automatic pagination response formatting
• 🔧 Laravel 9-12 Support - Compatible with multiple Laravel versions
• 🎯 Resource Classes - Built-in resource transformation classes
• 🔌 Response Macros - Extend Laravel's response with API methods
• 🌐 Global Helpers - Easy-to-use global helper functions
• 🛠️ Middleware Support - Automatic response formatting middleware
• 🚦 Rate Limiting Integration - Formatted rate limiting responses
• 📦 Response Compression - Automatic response compression (gzip, deflate)
• 🔄 API Versioning - Built-in API versioning support
• 📈 Performance Monitoring - Response performance tracking

📋 Requirements

• PHP >= 8.1
• Laravel >= 9.0

🔧 Installation

Via Composer

Manual Installation

1. Clone or download this package

2. Add to your composer.json:

3. Run composer update

⚙️ Configuration

Publish the configuration file:

This will create config/api-response.php with customizable options.

Production readiness

Before using in a live project:

1. Set APP_DEBUG=false in .env so error responses never expose stack traces or file paths.
2. Publish config (optional): php artisan vendor:publish --tag=api-response-config to override messages, structure, or timestamp format.
3. Override messages in config/api-response.php under messages so all default strings (e.g. "Resource not found") come from one place.
4. Optional: Enable include_request_id and include_error_codes in config for tracing and machine-readable error codes.

All responses use the same config (structure, timestamp, error codes). ResponseHelper and resources use the same settings as the main ApiResponse service.

Upgrading / Breaking changes

• Response caching removed: The package no longer provides api_cache(), api_remember(), or ApiResponseCache. For cached API responses, use Laravel’s Cache::remember() with api_success():

• 204 No Content: noContent() now returns an empty response body (RFC 7231) instead of a JSON body.
• Performance monitoring optional: Set register_performance_monitoring to false in config to disable cache usage when you do not use api_performance().

See CHANGELOG.md for full version history.

🎯 Quick Start

Basic Usage

Tip: For testability and flexibility, type-hint ApiResponseContract instead of ApiResponse so you can swap or mock the implementation.

📖 Usage Methods

Method 1: Service Injection

Method 2: Trait Usage

Method 3: Facade Usage

Method 4: Response Macros

Method 5: Global Helper Functions

Method 6: Resource Classes

📤 Response Methods

Success Responses

Error Responses

📋 Response Format

All responses follow this standardized format:

Success Response

Error Response

Pagination Response

🛡️ Exception Handling

The package includes a custom exception handler that automatically formats exceptions for API routes:

⚙️ Configuration Options

Response Structure

Default Messages

Other Options

🔄 Advanced Features

Middleware Support

API Versioning

Response Compression

Performance Monitoring

🧪 Testing

📊 Complete Example

Testing this package

Enterprise & production

For production use, enable request IDs and error codes in config; apply rate limiting and set APP_DEBUG=false.

🤝 Contributing

Please see CONTRIBUTING.md for development setup, code style, and pull request guidelines.

Security

If you discover a security vulnerability, please see SECURITY.md.

Changelog

See CHANGELOG.md for version history.

📄 License

This package is open-sourced software licensed under the MIT license.

🆘 Support

• Issues: GitHub Issues
• Documentation: Full Documentation

🙏 Acknowledgments

• Laravel team for the amazing framework
• All contributors who help improve this package
• The open-source community for inspiration and feedback

Laravel API Response – A generic package for standardized API responses.