Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wunderwerkio/jsonapi-error
Simple class to conveniently create a JSON error that complies with the JSON:API specification.
https://github.com/wunderwerkio/jsonapi-error
drupal json-api php-library php8 symfony
Last synced: 8 days ago
JSON representation
Simple class to conveniently create a JSON error that complies with the JSON:API specification.
- Host: GitHub
- URL: https://github.com/wunderwerkio/jsonapi-error
- Owner: wunderwerkio
- License: mit
- Created: 2023-03-29T13:15:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-04-05T13:48:30.000Z (over 1 year ago)
- Last Synced: 2024-04-24T16:48:04.491Z (7 months ago)
- Topics: drupal, json-api, php-library, php8, symfony
- Language: PHP
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSON:API Error
[](https://github.com/wunderwerkio/jsonapi-error/actions/workflows/main.yml)
This package provides `JsonApiError` and `JsonApiErrorResponse` classses to conveniently handle errors following the [JSON:API specification](https://jsonapi.org/format/#errors).
The `JsonApiErrorResponse` extends the `JsonResponse` from `symfony/http-foundation`, so this package is meant to be used in projects using that.
**Table of contents:**
- [Install](#install)
- [Usage](#usage)
- [Return a simple error response](#return-a-simple-error-response)
- [Return multiple errors](#return-multiple-errors)
- [Build response from `JsonApiError` objects](#build-response-from-jsonapierror-objects)
- [Local Development](#local-development)
- [Credits](#credits)
## Install
Install this package via composer:
```bash
composer require wunderwerkio/jsonapi-error
```
## Usage
### Return a simple error response
```php
'application_error_code',
'title' => 'An error occured!',
'status' => 500,
]);
}
```
The above code would result in a JSON response with the following payload:
```json
{
"errors": [{
"status": 500,
"code": "application_error_code",
"title": "An error occured!"
}]
}
```
### Return multiple errors
```php
422,
'code' => 'validation_failed',
'title' => 'Invalid request payload',
'detail' => 'The "name" field is required.',
'source' => [
'pointer' => '/data/name'
]
],
[
'status' => 422,
'code' => 'validation_failed',
'title' => 'Invalid request payload',
'detail' => 'The "description" field is required.',
'source' => [
'pointer' => '/data/description'
]
],
]);
}
```
The above code would result in a JSON response with the following payload:
```json
{
"errors": [{
"status": 422,
"code": "validation_failed",
"title": "Invalid request payload",
"detail": "The \"name\" field is required.",
"source": {
"pointer": "/data/name"
}
}, {
"status": 422,
"code": "validation_failed",
"title": "Invalid request payload",
"detail": "The \"description\" field is required.",
"source": {
"pointer": "/data/description"
}
}]
}
```
### Build response from `JsonApiError` objects
To ease building a response with multiple errors, the response can also be created by constricting it by
passing an array of `JsonApiError` objects.
```php
getContent();
$entity = json_decode($payload, TRUE);
// Make sure 'name' field is set.
if (!array_key_exists('name', $entity['data'])) {
$errors[] = JsonApiError::fromArray([
'status' => 422,
'code' => 'validation_failed',
'title' => 'Invalid request payload',
'detail' => 'The "name" field is required.',
'source' => [
'pointer' => '/data/name',
],
]);
}
// Make sure 'description' field is set.
if (!array_key_exists('description', $entity['data'])) {
$errors[] = JsonApiError::fromArray([
'status' => 422,
'code' => 'validation_failed',
'title' => 'Invalid request payload',
'detail' => 'The "description" field is required.',
'source' => [
'pointer' => '/data/description',
],
]);
}
if (!empty($errors)) {
return new JsonApiErrorResponse($errors);
}
return new JsonResponse([
'status' => 'success',
]);
}
```
## Local Development
A local dev environment can be created using `nix`:
```bash
# For PHP 8.1
nix develop '#.php81'
# For PHP 8.2
nix develop '#.php82'
# For PHP 8.3
nix develop '#.php83'
```
**Run tests**
```bash
composer test
```
**Lint with PHPStan**
```bash
composer analyze
```
## Credits
This project took inspiration from the following awesome projects:
- [`SineMah/json-api-error`](https://github.com/SineMah/json-api-error)