Download the PHP package jenky/api-error-bundle without Composer
On this page you can find all versions of the php package jenky/api-error-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jenky/api-error-bundle
More information about jenky/api-error-bundle
Files in jenky/api-error-bundle
Package api-error-bundle
Short Description A bundle that formats the JSON api problem
License MIT
Homepage https://github.com/jenky/api-error-bundle
Informations about the package api-error-bundle
A Symfony bundle that formats the JSON api problem
Standardize error responses in your Symfony application using RFC7807 Problem details or any custom error format.
Installation
You can install the package via composer:
If you are not using symfony/flex
, you'll have to manually add the bundle to your bundles file:
Configuration
Generic Error Response Format
By default all thrown exceptions will be transformed into the following format:
The debug information only available when application debug mode (
kernel.debug
) is on.
Example:
RFC7807 Problem details
You will need to create an alias from Jenky\ApiError\Formatter\ErrorFormatter
interface to api_error.error_formatter.rfc7807
.
For more information, please visit https://symfony.com/doc/current/service_container/autowiring.html#dealing-with-multiple-implementations-of-the-same-type.
Custom Error Format
Create your own custom formatter that implements ErrorFormatter
. Alternatively, you can extend the AbstractErrorFormatter
, provided for the sake of convenience, and define your own error format in the getFormat
method.
Register your service if needed, in case autowire
and autoconfigure
are disabled. Then create the alias:
Alternatively, you can use the GenericErrorFormatter
and configure ErrorFormatter
service with a Configurator:
Exception Transformations
If you want to add custom transformations, you should create a new class that implements the ExceptionTransformer
. With autoconfigured
enabled, you're all set. Otherwise, register it in Symfony container with the api_error.exception_transformer
tag.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CODE_OF_CONDUCT for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Lynh
- All Contributors
License
The MIT License (MIT). Please see License File for more information.