victormgomes / rest-messages
Standardized message responses for REST resources
Fund package maintenance!
Requires
- php: ^8.4
- doctrine/inflector: ^2.0
- illuminate/console: ^11.0||^12.0||^13.0
- illuminate/contracts: ^11.0||^12.0||^13.0
- illuminate/database: ^11.0||^12.0||^13.0
- illuminate/http: ^11.0||^12.0||^13.0
- illuminate/routing: ^11.0||^12.0||^13.0
- illuminate/support: ^11.0||^12.0||^13.0
- illuminate/translation: ^11.0||^12.0||^13.0
- spatie/laravel-package-tools: ^1.16
Requires (Dev)
- larastan/larastan: ^3.0
- laravel/pint: ^1.14
- nunomaduro/collision: ^8.8
- orchestra/testbench: ^10.0.0||^9.0.0
- pestphp/pest: ^4.0
- pestphp/pest-plugin-arch: ^4.0
- pestphp/pest-plugin-laravel: ^4.0
- phpstan/extension-installer: ^1.4
- phpstan/phpstan-deprecation-rules: ^2.0
- phpstan/phpstan-phpunit: ^2.0
- spatie/laravel-ray: ^1.35
This package is auto-updated.
Last update: 2026-04-28 07:58:42 UTC
README
Standardized message responses for REST resources
Introduction
Rest Messages is a lightweight package designed to standardize success messages across your Laravel REST API. It automatically detects the model name and the current CRUD action (index, store, update, destroy) to generate localized and professional response messages.
Why use this package?
- Consistency: Ensure every success response in your API follows the same linguistic pattern.
- Automatic Detection: No need to manually type messages for every controller action. The package "just knows" what you're doing.
- Localized: Built-in support for multiple languages with proper grammar and gender resolution for model names.
- Clean API: Focus on your data, while the package handles the communication part of your REST interface.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by sponsoring us on GitHub.
Installation
You can install the package via composer:
composer require victormgomes/rest-messages
Usage
Simply use the HasResourceMessages trait in your response helpers or base controllers.
use Victormgomes\RestMessages\Traits\HasResourceMessages; class ApiResponse { use HasResourceMessages; public function success($data) { return response()->json([ 'message' => $this->message(), 'data' => $data, ]); } }
The $this->message() method will automatically resolve the model and action from the current route context. For example, if called from UserController@store, it will return: "User created successfully."
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.