dharmvijay / laravel-api-response
Laravel api json response class with some features.
Installs: 9
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 3
Open Issues: 0
Type:helper
Requires
- php: >=5.5.9
- dharmvijay/laravel-api-response: master@dev
- laravel/framework: 5.*
- symfony/psr-http-message-bridge: 0.2
Requires (Dev)
- phpunit/phpunit: 5.3.*
This package is auto-updated.
Last update: 2024-09-06 23:21:14 UTC
README
Create a base api respnse class to laravel framework.
Installation
Require this package with composer:
composer require dharmvijay/laravel-api-response dev-master
Usage
Check below index and store operations
<?php namespace App\Http\Controllers; use Dharmvijay\LaravelApiResponse\APIResponse; use Illuminate\Support\Facades\DB; class HomeController extends Controller { protected $apiResponse; /** * Create a new controller instance. * * @return void */ public function __construct(APIResponse $apiResponse) { $this->apiResponse = $apiResponse; } /** * Show the application dashboard. * * @return \Illuminate\Http\JsonResponse */ public function index() { $data = ['mango', 'pineapple']; $response = $this->apiResponse->respondWithMessageAndPayload($data, 'fruits data found successfully.'); return $response; } /** * create new user * @return mixed|string */ public function store() { $data = []; DB::beginTransaction(); try { //... some operations here ... $response = $this->apiResponse->respondCreatedWithPayload( $data, "Backup created successfully." ); } catch (\Exception $ex) { DB::rollBack(); $response = $this->apiResponse->handleAndResponseException($ex); } DB::commit(); return $response; } }