Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nnjeim/respond
Laravel response wrapper
https://github.com/nnjeim/respond
json-api laravel laravel-package package response
Last synced: 26 days ago
JSON representation
Laravel response wrapper
- Host: GitHub
- URL: https://github.com/nnjeim/respond
- Owner: nnjeim
- License: mit
- Created: 2021-09-12T05:10:15.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-09-20T06:21:00.000Z (over 3 years ago)
- Last Synced: 2024-11-27T20:19:52.303Z (28 days ago)
- Topics: json-api, laravel, laravel-package, package, response
- Language: PHP
- Homepage:
- Size: 19.5 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
A Laravel response helper methods. The package `respond` provides a fluent syntax to form array or json responses.
In its configuration file, it allows the addition of custom methods.
## Installation
You can install the package via composer:
```
composer require nnjeim/respond
```
## Configuration
```
php artisan vendor:publish --provider="Nnjeim\Respond\RespondServiceProvider"
```
The `respond.php` config file allows:
- The presetting of the response format array/json.
- The possibility to edit the response parameters.
- The possibility to add custom methods.
## Usage
##### Respond Facade
```
use Nnjeim\Fetch\Fetch;
use Nnjeim\Respond\Respond;
['response' => $response, 'status' => $status] = Fetch::setBaseUri('https://someapi.com/')->get('countries');
if ($status === 200 && $response->success) {
return Respond::toJson()
->setMessage('countries')
->setData($response->data)
->withSuccess();
}
abort(400);
```
##### RespondHelper Instantiation
```
use Nnjeim\Respond\RespondHelper;
private RespondHelper $respond;
private array $data;
private bool $success;
public function __construct(RespondHelper $respond)
{
$this->respond = $respond;
}
.
.
.
$respond = $this
->respond
->toJson()
->setMessage('countries')
->setData($data);
if ($this->success)
{
return $respond->withSuccess()
}
return $respond->withErrors();
```
## Methods
##### Set the status code
```
Sets the response status code
@return $this setStatusCode(int $statusCode)
```
##### Set the message
```
Sets the response title message
@return $this setMessage(string $message)
```
##### Set the meta data
```
Sets the response meta data. The meta data will be merged with the response data array.
@return $this setMeta(array $meta)
```
##### Set the data
```
Sets the response data array.
@return $this setData(array $data)
```
##### Set the errors
```
Sets the response errors.
@return $this setErrors(array $errors)
```
##### respond in Json format
```
returns an instance of Illuminate\Http\JsonResponse
this method overwrites the config `toJson` set value.
@return $this toJson()
```
##### Respond with success
```
On success response. The default response status code is 200.
@return array|JsonResponse withSuccess()
```
##### Respond with created
```
On created response. The default response status code is 201.
@return array|JsonResponse withCreated()
```
##### Respond with accepted
```
On accepted response. The default response status code is 202.
@return array|JsonResponse withAccepted()
```
##### Respond with no content
```
On success response with no results found. The default status code is 204
@return array|JsonResponse withNoContent()
```
##### Respond with errors
```
On error response. The default response status code is 422.
@return array|JsonResponse withErrors(?array $errors = null)
```
##### Respond with server error
```
On server error response. The default response status code is 500.
@return array|JsonResponse withServerError()
```
##### Respond with not found
```
Record not found error. The default response status code is 404.
@return array|JsonResponse withNotFound()
```
##### Respond with not authenticated
```
Not authenticated reponse. The default response status code is 401.
@return array|JsonResponse withNotAuthenticated()
```
##### Respond with not authorized
```
Not authorized reponse. The default response status code is 403.
@return array|JsonResponse withNotAuthorized()
```
## Respond
```
@return array|JsonResponse
[
'response' => [
'success' => true,
'message' => 'message',
'data' => [],
'errors' => [],
],
'status' => 200,
];
```
## Custom methods
In the `respond.php` config file, in the responses array add an array entry where the key is name of the method in lower
case and the value contains the desired success, message and status params.
```
//example
'methodnotallowed' => [
'success' => false,
'message' => 'the method not allowed!',
'status' => Response::HTTP_METHOD_NOT_ALLOWED,
],
```
#### Usage
`Respond::withMethodNotAllowed();`
## Testing
The helpers and methods are tested with 99% coverage.
To run the tests.
``` bash
composer install
composer test
```
To run the coverage test.
``` bash
composer test-coverage
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.