Download the PHP package mahmoud-almalah/laravel-api-helpers without Composer

Laravel API Helpers

A clean and elegant Laravel package that provides a consistent and customizable structure for your API responses. Perfect for building maintainable, testable, and user-friendly APIs.

✨ Features

• ✅ Consistent JSON response format
• ✅ Localization via Accept-Language header (optional middleware)
• ✅ Built-in support for:
  • Collections with or without pagination
  • Single models/resources
  • Simple messages
  • Form request validation errors
• ✅ Laravel Responsable support
• ✅ Customizable success/error codes and messages
• ✅ Full test coverage with Pest
• ✅ Easy to use and integrate
• ✅ Designed for Laravel 11+

📦 Installation

No need to register the service provider if you’re using Laravel 5.5+ (package auto-discovery is enabled).

⚙️ Configuration

You may optionally publish the config if you need to customize success/error codes or messages:

🚀 Usage

✅ CollectionResponse

Returns a list of items with optional pagination metadata.

✅ ModelResponse

Wrap a single Eloquent model using a Laravel Resource.

✅ MessageResponse

Send a message-only response with optional data.

❌ FormRequestResponse

Use this for form validation errors (typically in custom validation handler).

Or you can just extend your form request from BaseRequest:

🌐 Localization Middleware

You can enable automatic localization of your API responses based on the Accept-Language request header using the ApiLocalizationMiddleware.

✅ Enable Localization

To activate the middleware globally for your API, first publish the config file:

Then update the localization settings in config/laravel-api-platform.php:

✅ Environment Variables

You can also set the localization settings using environment variables in your .env file:

If enabled, the package will automatically register a middleware that sets the app locale (and number formatting) based on the Accept-Language header:

You can also manually assign the middleware to specific routes if preferred:

The middleware automatically uses Laravel’s localization and number formatting services to ensure consistent responses based on language.

✅ Output Format

All responses follow this consistent format:

• status: true for success, false for errors
• message: human-readable message
• data: payload
• meta: only shown when pagination is present

✅ Testing

This package comes with full test coverage using Pest.

🛠 Development Tools

📂 Directory Structure

🤝 Contributing

Contributions are welcome! Please read the contributing guidelines for more information.

📄 License

The MIT License (MIT). See LICENSE for more information.