Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/93gaurav93/laravel-responder
A tiny Laravel package to format API responses.
https://github.com/93gaurav93/laravel-responder
api json json-api laravel laravel-responder laravel-response request responder response
Last synced: about 2 months ago
JSON representation
A tiny Laravel package to format API responses.
- Host: GitHub
- URL: https://github.com/93gaurav93/laravel-responder
- Owner: 93gaurav93
- License: mit
- Created: 2019-03-09T06:40:26.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-11T11:07:55.000Z (almost 6 years ago)
- Last Synced: 2024-10-12T09:14:26.020Z (3 months ago)
- Topics: api, json, json-api, laravel, laravel-responder, laravel-response, request, responder, response
- Language: PHP
- Size: 13.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Responder
[](https://styleci.io/repos/174658293)
[](https://packagist.org/packages/gaurav93d/laravelresponder)
A tiny Laravel package to format API responses.
## Installation
Via Composer
``` bash
$ composer require gaurav93d/laravelresponder
```
For Laravel version < 5.5, consider listing service provider and facade in `config/app.php`
``` php
'providers' => [
...
gaurav93d\LaravelResponder\LaravelResponderServiceProvider::class,
...
],
'aliases' => [
...
'Responder' => gaurav93d\LaravelResponder\Facades\Responder::class,
...
],
```
## Usage
#### Response format
``` json
{
"success": true,
"status": 200,
"data": [
"Here your beautiful data goes"
],
"errors": [
"Here your ugly errors go"
]
}
```
#### Send success
``` php
...
use gaurav93d\LaravelResponder\Facades\Responder;
...
Responder::success($data = [], $status = 200);
```
#### Send errors
``` php
...
use gaurav93d\LaravelResponder\Facades\Responder;
...
// Multiple errors
return Responder::errors($errors = [], $status = 200);
// Single error
return Responder::error($message = 'Error!', $status = 200);
// Validation errors
return Responder::respondValidationErrors(Validator $validator);
// Here are some comman error responses 👇
// Internal server error
return Responder::respondInternalError($message = 'Internal Error!'); // status = 500
// Unauthorized error
return Responder::respondUnauthorizedError($message = 'Unauthorized!'); // status = 401
// Bad request error
return Responder::respondBadRequestError($message = 'Bad Request!'); // status = 400
// Not found error
return Responder::respondNotFoundError($message = 'Not found!'); // status = 404
```
#### Attach response headers
``` php
...
use gaurav93d\LaravelResponder\Facades\Responder;
...
return Responder::headers($headers = [])->success($data = [], $status = 200);
...
return Responder::headers($headers = [])->errors($errors = [], $status = 200);
...
```
... :wink: Stay tuned! More features to come.
## Change log
Please see the [changelog](changelog.md) for more information on what has changed recently.
## Credits
- [Gaurav Deshpande](https://github.com/93gaurav93)
## License
MIT. Please see the [license file](LISCENSE.md) for more information.