https://github.com/ymigval/laravel-sl-response
A Laravel package for streamlined API response formatting and management, ensuring consistency and adherence to API standards. Simplify error handling and customize response formats with ease.
https://github.com/ymigval/laravel-sl-response
api format formatting json laravel response standard
Last synced: about 1 year ago
JSON representation
A Laravel package for streamlined API response formatting and management, ensuring consistency and adherence to API standards. Simplify error handling and customize response formats with ease.
- Host: GitHub
- URL: https://github.com/ymigval/laravel-sl-response
- Owner: ymigval
- License: mit
- Created: 2023-11-01T22:45:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-26T19:12:21.000Z (over 1 year ago)
- Last Synced: 2025-06-09T11:49:43.485Z (about 1 year ago)
- Topics: api, format, formatting, json, laravel, response, standard
- Language: PHP
- Homepage:
- Size: 71.3 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel API Response Formatter
The `ymigval/laravel-sl-response` package simplifies API response management in Laravel applications. It allows you to structure and format API responses with ease, ensuring consistency and adherence to API standards.
### Key Features
- **Consistent Responses**: Generate API responses with a standardized structure, including status codes, messages, and data, providing a uniform and professional look to your API.
- **Error Handling**: Efficiently manage error responses with detailed error messages, appropriate status codes, and response formatting that complies with best practices.
- **Customization**: Tailor the response format to suit your project's specific needs, offering flexibility to meet various API requirements.
- **Laravel Integration**: Seamlessly integrates with Laravel, enhancing Laravel's response system with additional features.
- **Time Efficiency**: Reduce the development effort required for consistent API responses, allowing you to focus on your application's core functionality rather than response formatting.
The `ymigval/laravel-sl-response` package empowers you to build and maintain professional, reliable APIs that meet industry standards. Whether you're developing a new API or improving an existing one, this package is an invaluable addition to your Laravel toolkit.
## Installation
You can install the package via Composer:
```bash
composer require ymigval/laravel-sl-response
```
You can publish the configuration file using the following command:
```bash
php artisan vendor:publish --tag="slresponse"
```
## Usage
Response from a route or controller method.
```php
use Ymigval\LaravelSLResponse\Facades\SLResponse;
use Ymigval\LaravelSLResponse\Exceptions\SLException;
// Collection of users
return SLResponse::ok(User::all());
// A User resource
return SLResponse::ok(new UserResource(User::find(1)));
// If you want to disable the outermost wrapping.
return SLResponse::ok(UserResource::collection(User::paginate(10)))
->withoutWrapping();
// Attach additional messages.
return SLResponse::ok(User::find(6)->isAdmin())
->withMessage("This user is an admin");
// Return an error response.
return SLResponse::error('Limit exceeded');
// Additionally, you can add an error code as the second argument.
return SLResponse::error('Limit exceeded', '3748');
// Throw an exception
throw new SLException('This is a message.');
```
## Changelog
Please refer to the [CHANGELOG](CHANGELOG.md) for more information about recent changes.
## License
The MIT License (MIT). For more information, please see the [License File](LICENSE).