Download the PHP package lanin/laravel-api-exceptions without Composer
On this page you can find all versions of the php package lanin/laravel-api-exceptions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 laravel-api-exceptions
Laravel-API-Exceptions
All in one solution for exception for JSON REST APIs on Laravel and Lumen.
About
The goal of this package is to provide you with a set of most common exceptions that may be needed while developing JSON REST API. It also:
- Handles exceptions output.
- Handles exceptions report to logs.
- Overwrites default Validator to make validation errors more verbose.
- Has a FormRequest that to handle validation errors and pass them to ApiExceptions layer.
Installation
PHP 5.4+ or HHVM 3.3+, Composer and Laravel 5.1+ are required.
To get the latest version of Laravel Laravel-API-Debugger, simply add the following line to the require block of your composer.json file.
For Laravel 5.1
For Laravel 5.3
You'll then need to run composer install or composer update to download it and have the autoloader updated.
Once Laravel-API-Exceptions is installed, if you're using Laravel 5.1, 5.2, 5.3, and 5.4, you need to register the service provider. Open up config/app.php and add the following to the providers key.
If you're using Laravel 5.5, you don't need to add anything in config/app.php. It will use package auto discovery feature in Laravel 5.5.
Exceptions
Every ApiException can be thrown as a normal exception and they will be automatically serialized to JSON with corresponding HTTP status, if user wants json:
This object will be also populated with trace info, when APP_DEBUG is true.
Also it can have meta attribute when there is additional info. For example for validation errors:
For ValidationApiException, meta attribute has errors object that contains validations errors.
Every attribute of this object is a name of a request parameter to validate to and value is an array of errors with description.
Customization
You can customize errors APU response by overriding formatApiResponse method in your ExceptionsHandler.
For example if you want to put everything under error attribute, you can do it like this:
Handler
Extend your default exceptions handler with:
\Lanin\Laravel\ApiExceptions\LaravelExceptionHandlerfor Laravel\Lanin\Laravel\ApiExceptions\LumenExceptionHandlerfor Lumen
And remove everything else. Example:
FormRequest
To use FormRequest extend all your Request classes with \Lanin\Laravel\ApiExceptions\Support\Request.
It will automatically support validation errors and pass them to the output.
It also has a very handy helper method validatedOnly() that returns from request only those items that are registered in rules method.
Contributing
Please feel free to fork this package and contribute by submitting a pull request to enhance the functionalities.
