README

Laravel API resource is a fantastic feature to make REST API. We are using it to transform eloquent models to json responses.

We know every resource route give us seven individual api link and their work is almost similar. I have made it more generic by using a wrapper!

Installation

Install the latest version with

$ composer require shohag-laraql/lara-ql

Model Usage

<?php

namespace App\Models;

use Shohag\Interfaces\LaraQLSerializer;
use Shohag\Models\LaraQLModel;

class Division extends LaraQLModel implements LaraQLSerializer
{

    /**
     * @var one to one model relation
    */
    protected $one2oneFields = [
        [
            'self_key' => 'country_id', // current table foreign key
            'associate_with' => 'country', // request field
            'relative_model' => Country::class // relative model 
        ]
    ];
  
    public function __construct()
    {
        parent::__construct($this);
    }
    
    /**
     * @param NULL
     * @return $mixin
     */
    public function country() {
        return $this->belongsTo(Country::class, 'country_id', 'id')->select(['id', 'name']);
    } 

    /**
     * @param NULL
     * @return Array
     */
    public function serializerFields(): array
    {
        return ['id', 'name','country_id', 'country__name'];
    }

    /**
     * @param NULL
     * @return Array
     */
    public function postSerializerFields(): array
    {
        return ['name','country_id'];
    }

    /**
     * @param NULL
     * @return Array
     */
    public function fieldsValidator(): array
    {
        return [
            'name' => 'required',
            'country_id' => 'required'
        ];
    }

     /**
     * @param NULL
     * @return Array
     */
    public function createSerializer(): array
    {
        return [
            'direct_fields' => [
                [
                'level' => 'country',
                'model' => Country::class, // country_id foreign key of division table
                'fields' => ['id', 'name']
                ]
            ]
        ];
    }
    
     /**
     * @param NULL
     * @return array
     */
    public function fieldMutation(): array
    {
        return [
            [
                'field' => 'name',
                'method' => function($fieldValue) {
                    return strtoupper($fieldValue);
                }
            ]
        ];
    }

}
?>

Controller Usage

<?php

namespace App\Http\Controllers;

use App\Models\Division;
use Shohag\Controllers\LaraQLController;

class DivisionController extends LaraQLController
{
    public function __construct(Division $division)
    {
        $this->EntityInstance = $division;
        parent::__construct(); 
    }
}

Route Usage

Route::resource('/divisions', 'DivisionController');

Verb          Path                        Action  Route Name
GET           /divisions                   index   divisions.index
GET           /divisions/create            create  divisions.create
POST          /divisions                   store   divisions.store
GET           /divisions/{id}              show    divisions.show
GET           /divisions/{id}/edit         edit    divisions.edit
PUT|PATCH     /divisions/{id}              update  divisions.update
DELETE        /divisions/{id}              destroy divisions.destroy

Usage

LaraQL

Documentation

Without Filter

divisions GET /api/divisions
Response

{
    "data": [
        {
            "id": 3,
            "name": "Dhaka",
            "country_id": 1,
        },
        {
            "id": 2,
            "name": "Khulna",
            "country_id": 2,
        }
    ]
}

Single Filter

divisions with single filter: GET api/divisions?filters=country_id:2
Response

{
    "data": [
        {
            "id": 2,
            "name": "Khulna",
            "country_id": 2,
        }
    ]
}

Multiple Filter

divisions with multiple filter: GET api/divisions?filters=country_id:2,name:Khulna
Response

{
    "data": [
        {
            "id": 2,
            "name": "Khulna",
            "country_id": 2,
        }
    ]
}

Like Filter

divisions like filter: GET api/divisions?filters=country_id:2,like~name:ulna
Response

{
    "data": [
        {
            "id": 2,
            "name": "Khulna",
            "country_id": 2,
        }
    ]
}

Query Fields

queryFields filter(only desire fields retrive): GET /api/divisions?queryFields=id,name
Response

{
    "data": [
        {
            "id": 2,
            "name": "Khulna",
        }
    ]
}

Between Filter

between filter(range 1 to 3): GET /api/countries?filters=b2n_id:1-3
Response

{
    "data": [
        {
            "id": 3,
            "name": "India"
        },
        {
            "id": 2,
            "name": "India"
        },
        {
            "id": 1,
            "name": "Bangladesh"
        }
    ]
}

Order By

filter with order_by: GET /api/countries?filters=b2n_id:1-3&queryFields=id,name&order_by=asc
Response

{
    "data": [
       {
            "id": 1,
            "name": "Bangladesh"
        },
        {
            "id": 2,
            "name": "India"
        },
        {
            "id": 3,
            "name": "India"
        }
    ]
}

ForeignKey Fields

Foreignkey queryFields(desire foreignkey field retrive): GET /api/divisions?queryFields=country__name
Response

{
    "data": [
        {
            "id": 2,
            "name": "Khulna",
            "country_id": 1,
            "country_name": "Bangladesh"
        }
    ]
}

Resource Post

new resource create: POST: /api/divisions
body

{
    "name": "Mymensingh",
    "company_id": 1,
}

Bulk Post

new bulk resource create: POST: /api/divisions
body

{
  "bulks": [
    {
      "name": "Sylhet",
      "country_id": 1,
      
    },
    {
      "name": "Rajshahi",
      "country_id": 1
    }
  ]
}

One to one

division with country create(one to one relation data insert): POST: /api/divisions

Before you do this make sure you removed country_id from validation method and added $one2oneFields property in model

body

{
	"name": "Rajshahi",
	"country": {
		"name": "Bangladesh"
	}
}

One To Many

one to many data insert: POST: /api/type

Add $one2manyFields property in model

protected $one2manyFields = [
        [
            'relation_id'=> 'division_id',   
            'associate_with' => 'divisions', 
            'relative_model' => Division::class
        ]
    ];

body

{
	"name": "Division",
	"items": [
		{
		  "name": "sub division"
		},
		{
		  "name": "super division"
		}
	]
}

divisions create: GET: /api/divisions/create
Response

// Model createSerializer() method will be work here
{
    "data": {
        "country": [
            {
                "id": 1,
                "name": "Bangladesh"
            }
        ]
    }
}

Field Mutation

   /**
   * @param NULL
   * @return array
   */
    public function fieldMutation()
    {
        return [
            [
                'field' => 'code',
                'method' => function($fieldValue) {
                    return (int)$fieldValue;
                }
            ],
            [
                'field' => 'name',
                'method' => function($fieldValue) {
                    return strtoupper($fieldValue);
                }
            ]
        ];
    }

Author

License

LaraQL package is licensed under the MIT License

shohag-laraql / lara-ql

Maintainers

Details