Download the PHP package waad/laravel-generate-repository-api without Composer

Generate Repository Design Pattern Api

you can create your restful api easily by using this library with filtering sorting

Installation:

Require this package with composer using the following command:

in config/app.php

⚠️ Change Default Guard from config/auth.php => defaults.guard if you want use differnet guard.

\  

in config/database.php if use search multi column

\  

🚀 About Me

I'm a Back End developer...

• Author : Waad Mawlood

• Email : [email protected]

YAML Roadmap Job Of Package

Usage

- Generating All

if use force

in all that will generate (model, migration, controller api, repository, interface, properties, request forms, route string in api or web)

- Generating Some

\  

- After migration Create validation And DTO Files

create table columns in migration and do migration

- Create permissions of model into database customs

⚠️ use it if refresh database or drop permissions from database `

`

`

\  

- Filtering, Sorting And Properties Of Model

Example In properties/Car/CarPropertable

if you add manually

• fillable : fill allowed fields to inserting and updating from $fillable_override array property

• filtering : fill allowed fields to filtering from $filterable array property that use filter,find parameter in request

• sorting : fill allowed fields to sorting from $sortable array property

• Other :

\  

- Accessor And Mutator Of Model

Example In properties/Car/CarAccessorable And properties/Car/CarMutatorable

if you add manually

• In Accessor and Mutator files there are some examples to create accessor And Mutator methods

• Appending : add attributes for response from $appends_override array in Accessorable file

\  

- Scopes Of Model

Example In properties/Car/CarScopable

if you add manually

• In Scopable file there are some examples to create scope methods

\  

- Related Of Model

Example In properties/Car/CarRelatable

if you add manually

• In Relatable file there are some examples to create Relationship methods with other models

• including : model allow include (join) with other model Relationship by used $includeable array property example user, user.city when use include=model,user.city in request
• Other :

⚠️ don't remove use ConstructorableModel; in Relatable

\  

- Policy Of Controller

Example In Policies/CarPolicy

• first : Add Triats to any model used Authontication eg . User, Admin in Model

Example

if you choose generate policy in command line with creating policy for model and controller will call to it automatic from cosntructor of controller ex $this->authorizeResource(Car::class, 'car');

• if don't define policy because of named or another problem define it from app/Providers/AuthServiceProvider.php

example

🔥 Change Role Of Super from config/laravel-generate-repository-api.php

❤️   to clear cache of config

Example Policy for HasAnyRolePermissions

\   \  

Examples with Requests

\  

• http://127.0.0.1:8000/api/cars?include=user.city,model,color&sort=-date_made,user.name&select=id,name,age&except=age,notes

• http://127.0.0.1:8000/api/cars?include=user.city&filter[user.city.name]=baghdad => user.city.name LIKE baghdad

• http://127.0.0.1:8000/api/cars?include=user.city&find[user.city.name]=baghdad&find[model.year]=lt:1995:or:gt:2020

=> (user.city.name = baghdad) And (model.year < 1995 OR model.year > 2020)

• find same filter but not use Like Operator by default Equal =

😍 If you send values by base64 example find[user.age]={{b64(NTY=)}} => find[user.age]=56

\  

- Use Pagination Or Unlimit Takes with Request

Use take and page Parameters

• Pagination : use Pagination request form with take 100 default eg.

• Unlimit : use Unlimit request form with take 100 default if use take eg.

\  

- Return Trashed Records if use soft delete

Use trash parameter including these values:

\  

- Use DTO Model, Pagination and List Responses

• one model use direct DTO eg.

• Pagination model use paginate DTO from package eg.

OR

• List model use List DTO from package eg.

OR

\  

License

MIT