Laravel API response format
Laravel API response format
In this article, we will see how to solve "Laravel API response format".
You can create a common response format for API response using a function in laravel. You can call this function to return the data or errors as an API response on call a route in laravel.-
Function to create laravel API response format
function create_output($is_success = false, $error=[], $data=[]) { if( $is_success ) { $output = ['success' => 1]; if(count($data) > 0) { $output['data'] = $data; } } else { $output = [ 'success' => 0, 'errors' => $error ]; } return $this->array_filter_recursive($output); } function array_filter_recursive($array, $callback = null) { return $array; foreach ($array as $key => & $value) { if (is_array($value)) { $value = $this->array_filter_recursive($value, $callback); } else { if ( ! is_null($callback)) { if ( ! $callback($value)) { $array[$key] = ''; } } else { if ( ! (bool) $value) { $array[$key] = ''; } } } } unset($value); return $array; } //Call function and return data as API response //Return the status success with data return $this->create_output(1, [], [ 'id' => $user->id ]); // Return success with no data return $this->create_output(1); //Return status (success) false with validation error message return $this->create_output(0, $validator->errors()->all());
You can create a trait and copy/paste function in the trait file and call the function in from the controller’s method after importing the trait in the controller file.
If you like what you are reading, please consider buying us a coffee ( or 2 ) as a token of appreciation.
Don't forget to share this article! Help us spread the word by clicking the share button below.
We appreciate your support and are committed to providing you valuable and informative content.
We are thankful for your never ending support.
Random Code Snippet Queries: Laravel
- Json encode method in laravel
- JQuery each loop on json response after ajax in laravel
- Get duplicate records in laravel
- How to get tomorrow and yesterday date in laravel
- How to pass two variables in HREF in laravel
- How to display user profile after login in laravel
- Display option of select as selected with blade directive Laravel
- Add class to body in laravel view
- How to update record after save method in Laravel
- How to pass link from controller to view in laravel on ajax call
- Extra Filter Query on Relationships in Laravel
- Split an Eloquent Collection by half in Laravel
- Laravel 9 pagination with search filter
- How to customize or Change validation error messages
- Cast Array to an Object in Controller and then pass to view in laravel
- Input file with max size validation in laravel
- Create model with migration and seeder
- How to create belongstomany relation using custom name on custom pivot table
- Get content from web URL in laravel
- Seed database using SQL file in Laravel
- Method chaining in Laravel
- First and last item of the array using foreach iteration in laravel blade
- Laravel specific table Migration
- Declaration of App\Models\Post::sluggable() must be compatible with Cviebrock\EloquentSluggable\Sluggable
- How to check if user has created any post or not in laravel