Download the PHP package salmanzafar/laravel-api-exceptions-handler without Composer
On this page you can find all versions of the php package salmanzafar/laravel-api-exceptions-handler. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download salmanzafar/laravel-api-exceptions-handler
More information about salmanzafar/laravel-api-exceptions-handler
Files in salmanzafar/laravel-api-exceptions-handler
Package laravel-api-exceptions-handler
Short Description A Laravel package that makes it easy to handle and customize api exceptions and responses
License MIT
Informations about the package laravel-api-exceptions-handler
laravel-api-exceptions-handler
A Laravel package that makes it easy to handle and customize api exceptions and responses and also support for model uuid
Table of contents
- Installation
- Configuration
- Api Exceptions
- Custom Api Responses
- Model Uuid
- Publishing files / configurations
Installation
Configuration (optional)
Publishing service provider
Enable the package (Optional)
This package implements Laravel auto-discovery feature. After you install it the package provider and facade are added automatically for laravel >= 5.5.
Api Exceptions
There are many cases in which you want to return a custom response to an api instead of a default response
For example you have a api to get user and you want to return a custom response instead of laravel default response
in above case by default laravel will throw 404 exception if user is not found. now let's see how we can customize this:
Go to app\Exceptions\Handler.php
and copy and paste the below part
ExceptionTrait
has all the exceptions handling- In
render function
we've added a conditional check add then returnedapiExceptions
Now it'll return a the json customized response instead of default laravel response (see below):
Custom Api Responses
There are plenty of cases where ypu want to customize the laravel default validation/form request response so in thise cas this will help you customizing your response
Let's see the default validation response for laravel
Now Let's modify this by creating a form request e.g CarRequest.php
Now the api response will be:
What we did we just added failedValidation
in our request and throwed our exception
you can easily modify the above the error based on your needs just publishing this this file MyValidationException
Model Uuid
There are many cases where we want to use uuid
as primray key
in our model now that is also easier you can use uuid
as pk
in a jiffy
By just using UsesUuid
in your model now you have uuid
as pk
in your model. don't forget to make changes in migration
Publishing files
The below command will publish all related files inside App\Concerns
folder