Behamin standard formats for api responses.
composer require behamin/bresourcesResources:
{
"data": {
"id": 1,
"email": "[email protected]"
},
"message": "message",
"error": {
"message": "or error message",
"errors": null
}
}ResourceCollection:
{
"data": {
"items": [],
"count": 0,
"sum": null
},
"message": null,
"error": {
"message": null,
"errors": null
}
}On validation error for requests (with 422 status code):
{
"data": null,
"message": null,
"error": {
"message": "first error message in message bag",
"errors": {
"password": [
"password field is required."
]
}
}
}Create resources and requests with artisan commands and pass data, message, error_message or count to resources like following examples:
public function index(EmailFilter $filters)
{
list($emails, $count) = Email::filter($filters);
$emails = $emails->get();
return EmailResource::collection(['data' => $emails, 'count' => $count]);
} public function show(Email $email)
{
return new EmailResource(['data' => $email, 'message'=> 'email info.']);
}You can specify output fields from transformDataItem() method of resource classes.
<?php
namespace App\Http\Resources;
use Behamin\BResources\Resources\BasicResource;
class EmailResource extends BasicResource
{
protected function transformDataItem($item)
{
return [
'id' => $item->id,
'email' => $item->email,
'status' => $item->status
];
}
}Also, you can use apiResponse() helper function to directly send response
class PhoneController {
public function show(Phone $phone)
{
return apiResponse()->data($phone)->message('phone info.')->status(200)->get();
}
public function index() {
$phones = Phone::all();
return apiResponse()->collection($phones, $phones->count())->message('phone info.')->status(200)->get();
}
public function update(Request $request, Phone $phone) {
$isUpdated = $phone->update($request->all());
if (!$isUpdated) {
return apiResponse()->errors('phone is not updated');
}
return apiResponse()->data($phone)->message('phone is updated')->get();
}
public function delete(Phone $phone)
{
$phone->delete();
return apiResponse()->message('phone info.')->next('https://debut.test')->status(200)->get();
}
}In above example message and status are optional, and their default value respectively are null and 200.
php artisan make:bresource ResourceClassNamephp artisan make:brequest RequestClassName
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent