Laravel Api Response
The package will help to generate json answers.
Installation
$ composer require kolirt/laravel-api-response
Example
Error response.
return api()
->error()
->setCode(400) // default code 400
->setDescription(['Description #1', 'Description #2'])
// or
->setDescription('Description')
->setData(['Data #1', 'Data #2'])
// or
->setData('Data')
->render();[
'ok' => false,
'error_code' => 400,
'description' => ['Description #1', 'Description #2'],
// or
'description' => 'Description',
'result' => ['Data #1', 'Data #2'],
// or
'result' => 'Data',
]Success response.
return api()
->success()
->setCode(200) // default code 200
->setDescription(['Description #1', 'Description #2'])
// or
->setDescription('Description #1')
->setData(['Data #1', 'Data #2'])
// or
->setData('Data')
->render();[
'ok' => true,
'description' => ['Description #1', 'Description #2'],
// or
'description' => 'Description',
'result' => ['Data #1', 'Data #2'],
// or
'result' => 'Data',
]Methods
error
Default response code 400.
return api()->error();success
Default response code 200.
return api()->success();setCode
Set custom response code. Available codes.
return api()->setCode($code);setDescription
Set description to response.
return api()->setDescription(['Description #1', 'Description #2']);
// or
return api()->setDescription('Description');setErrors
Set description to response.
return api()->setErrors([
'first_name' => 'Error message',
'last_name' => ['Error message 1', 'Error message 2']
]);abort
return api()->abort('Error message', 400);cookie
Add cookie to response.
return api()->cookie(cookie('token', 'asdsadsadas', 60 * 3));setData
Set data to response.
return api()->setData(['Data #1', 'Data #2']);
// or
return api()->setData('Data');render
Render response.
return api()->render();
