dipenparmar12 / responder
A Laravel package for custom api response payload
Requires
- php: ^7.1
This package is auto-updated.
Last update: 2024-08-25 22:02:04 UTC
README
Installation
You can install the package via composer:
composer require dipenparmar12/responder
Usage
Syntax for success response
response()->success( $message [, $data = null, $subStatus = 200, $finalStatus = 200])
Syntax for error response
return response()->error( $message [, $data = null, $subStatus = 400, $finalStatus = 200])
Example
return response()->success( 'data inserted', $data, 200, 200)
[
'success' => true,
'message' => "data inserted",
'status' => 200,
'path' => '/uri-segment',
'results' => $your_data,
'metadata' => [
'auth_id' => 'loged_in_user_id or null',
'url' => 'url'
]
]
return response()->error( 'error occured', request()->all(), 401, 500)
[
'success' => false,
'message' => "error occured",
'status' => 401,
'path' => '/uri-segment',
'results' => $your_data,
'metadata' => [
'auth_id' => 'loged_in_user_id or null',
'url' => 'url'
]
]
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email dipenparmar12@gmail.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.