alighorbani/responder

Make a Response to as fast as light!

dev-master 2022-06-07 10:19 UTC

This package is auto-updated.

Last update: 2024-04-07 14:37:30 UTC


README


🚀 Generate API Response as fast as light!

We solve some problem for You with a package You can call Responder

actually developers make a specific structure for api that developed

✅️ Advantages

  1. You don't need to set pagination logic in your resource because inject automatically
  2. You can make a different response with elegant syntax (use facade)
  3. Automatic Message Mapper on response for example(title => users-list)
  4. Prevent Human mistakes when generate response structure manually
  5. Unlimited Define Structure and used in project
  6. If you decide to Change Your you can do this with little changed

👨‍💻 Usage

In this Example use the resource that contains several items (such as users list)

<?php

use Jenssegers\Mongodb\Eloquent\Model;
use Alighorbani\Responder\ResponderFacade;

class UserController extends Model
{
    public function getUsersList()
    {
        $users = User::all();
        
        return ResponderFacade::resourceResponse($users, 'USERS.LIST', UserResource::class);
    }
}
{
    "success": true,
    "title": "The List of Users Resource",
    "result": [
        {
            "id": 1,
            "name" : "Ali",
            "lastname" : "Ghorbani",
            "birthday" : "2003-01-01"
        },  
        {
            "id": 2,
            "name" : "Mohammad",
            "lastname" : "Karimi",
            "birthday" : "2003-02-18"
        }
    ]
}

TODO

  • Installing With Composer Package & Dependencis
  • how to use the make responder
  • how to use the message config
  • how to use the macroable on this package (to add functionality)