Download the PHP package jenky/api-error without Composer
On this page you can find all versions of the php package jenky/api-error. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jenky/api-error
More information about jenky/api-error
Files in jenky/api-error
Package api-error
Short Description Standardize error responses in API applications
License MIT
Homepage https://github.com/jenky/api-error
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api-error
Api Error
This package provides an implementation for API error formatting. It can be integrated throughout your code and should result in a standardized error response format for HTTP APIs.
Quick start
Since handling the exceptions is up to the framework, here are a list of supported integrations:
Symfony HTTP Foundation Based Framework
Bring Your Own
You can install the package via composer:
The usage may vary depending on your project. Typically, you should handle it in your global exception handler. Here is a minimal example:
Building Blocks
Error Formatter
The error formatter is the main entry point of the package. It formats the Throwable exception into a serializable version, allowing the data structure to be used as the response body, typically in JSON. An error formatter must implement ErrorFormatter.
Internally, the error formatter transforms the exception into a Problem, which should return an array as context data for the given exception. This array can contain anything, and when combined with the predefined response error format, will be used to replace placeholders with contextual data.
You can always create your own Problem using the Exception Transformer.
GenericErrorFormatter
Rfc7807ErrorFormatter
- Placeholder names MUST correspond to keys in the context array.
- Placeholder names MUST be delimited with a single opening brace
{and a single closing brace}. There MUST NOT be any whitespace between the delimiters and the placeholder name. - Placeholder names SHOULD be composed only of the characters
A-Z,a-z,0-9, underscore_, and period..
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.
Exception Transformations
An exception transformer is used to customize the transformation of a Throwable exception into a Problem, allowing you to add or modify the context data. If you want to add custom transformations, you should create a new class that implements the ExceptionTransformer and pass it as a second argument of the error formatter.
If you have multiple transformers, use the ChainTransformer to run all of them.
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.
