https://github.com/macropay-solutions/laravel-lumen-crud-wizard
Build RESTful services without codding the filters manually
https://github.com/macropay-solutions/laravel-lumen-crud-wizard
aggregation-framework crud-api crud-generator filtering-data laravel lumen query-builder query-language-processor query-language-sql restful-client restful-webservices restfull-api
Last synced: about 1 month ago
JSON representation
Build RESTful services without codding the filters manually
- Host: GitHub
- URL: https://github.com/macropay-solutions/laravel-lumen-crud-wizard
- Owner: macropay-solutions
- Created: 2023-12-12T14:55:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-15T00:03:42.000Z (about 1 year ago)
- Last Synced: 2024-03-15T19:05:29.988Z (about 1 year ago)
- Topics: aggregation-framework, crud-api, crud-generator, filtering-data, laravel, lumen, query-builder, query-language-processor, query-language-sql, restful-client, restful-webservices, restfull-api
- Homepage:
- Size: 53.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# laravel-lumen-crud-wizard
## Url query language lib for RESTful CRUD (micro) services using lumen/laravel 8-9-10-11-12
### This is not just another CRUD lib!
It has built in filtering capabilities that can be used for listing but also for mass deleting, so it could be called a CRU**F**D (create, read, update, **filter** and delete) lib instead.
#### Build RESTful services with lightning speed for any number of resources and relations using rest crud library that offers revolutionary filtering (and aggregating) capabilities for resources and their relations.
```Long story short: so you don't have to code the filters by hand.```
For free version see [Laravel Crud Wizard Free](https://github.com/macropay-solutions/laravel-crud-wizard-free)
See also [Laravel Lumen Crud Wizard Decorator](https://github.com/macropay-solutions/laravel-lumen-crud-wizard-decorator).
I. [You get](#i-you-get)
II. [Features](#ii-features)
II.1. [Create resource](#ii1-create-resource)
II.2. [Read / Get resource](#ii2-readget-resource)
II.3. [Update / Upsert / Increment resource](#ii3-updateupsertincrement-resource)
II.4. [Delete resource](#ii4-delete-resource)
II.5. [Bulk delete resource](#ii5-bulk-delete-resource)
II.6. [List resource](#ii6-list-resource)
II.7. [Composite primary key](#ii7-composite-primary-key)
II.8. [Sql debugging/logging](#ii8-sql-debugginglogging)
II.9. [Error handling/logging](#ii9-error-handlinglogging)
II.10. [Datetime NOT timestamp for created_at and updated_at columns](#ii10-datetime-not-timestamp-for-created_at-and-updated_at-columns)
II.11. [Autocomplete on model properties](#ii11-autocomplete-on-model-properties)
II.12. [Read-only DTO for model](#ii12-read-only-dto-for-model)
III. [Usage](#iii-usage)
IV. [Try it](#iv-try-it)
## I. You get:
- [laravel-crud-wizard-client](https://github.com/macropay-solutions/laravel-lumen-crud-wizard-client): request builder that is used to encode the request in the request initiator project + documentation (min PHP 7.4 or 8.0) capable of async calls for count to speed up the list on big tables
- laravel-crud-wizard: request parser or translator into sql for the request target project + documentation (min PHP 8.0)
- [laravel 9 demo project that uses laravel-crud-wizard](https://github.com/macropay-solutions/laravel-crud-wizard-demo)
The code follows **PSR 12** coding standard and **DRY** principle.
Can be used with **laravel/lumen 8-9-10-11** and **sql** databases (tested on mysql/mariadb but can also support sqlite, sqlsrv, pgsql).
Can be used to generate sql for **Elasticsearch**.
**The lib is proprietary and can be used only after an agreement.**
**On request we can issue a test token to be used on a laravel 9 DEMO project that has a dummy db. The url query language can be tested/tried without a token (only for filtering) in our [demo page](https://laravel-crud-wizard.com/laravel-9/laravel-lumen-crud-wizard).**
**If interested, please [contact us](https://macropay.net/contact/).**
## II. Features:
#### II.1. Create resource
- only with allowed fields
#### II.2. Read/Get resource
- also with relations, appends, count relations and exist relations
#### II.3. Update/Upsert/Increment resource
- only with allowed fields (or create if not found, if (pk) incrementing = false or by custom condition if the identifier is other than the pk)
- also with relations, appends, count relations and exist relations
- supports **incrementing** for the summable columns ONLY. Use "++x[.xx]" or "--x[.xx]". Incrementing can be made together with other updates. Incrementing is possible only on existing resource.
#### II.4. Delete resource
- only if allowed
#### II.5. Bulk delete resource
- only if coded using $service->list({Controlled filters})->delete();
- not built-in
#### II.6. List resource
- **list resource** /resource?...
- **list the resource's relation (as a resource)** /resource/{pk}/{relationName}?...
- **list response as JSON or XLS**
(with relations in different sheets) controlled via request header `Accept application/xls or application/json`
- **multi sorting on the resource's columns and on its aggregations and default sort**
- **in header query for GET requests or POST requests for filtering with sensitive data**
- **to avoid 499 http code in access logs and DB block via api call, the DB select statements are restricted with a timeout for mysql >= 5.7.4 and mariadb >= 10.1.1**
- **aggregations** (**including on the relation's columns**)
sums,
averages,
minimums,
maximums,
distinct column(s) fetching (including custom sql: 'distinct COALESCE(NULLIF(`{table}`.`column`, ""), `{table}`.`column2`) as column)',
group by (columns of the resource plus relation counts and date cast able columns, but if index required on filtering is enabled then first group by column MUST be indexed and not casted; if distincts are used then group by is disregarded),
sub totals,
sub averages,
sub minimums,
sub maximums,
count distinct,
group count,
count relations,
exist relations,
havings (including relation counts, group counts, count distincts, sums, averages, minimums, maximums),
- **filters for resource and relations:**
from (inclusive),
to (inclusive),
in,
not in,
starts with,
is null (inluding also (column in (...) OR column IS NULL) condition),
is not null,
contains (not fulltext search),
notContains,
- **pagination** (LengthAwarePaginator as default or Paginator or CursorPaginator)
page,
limit, // limit=0 for count only without pages
simplePaginate (request response without total count)
cursor
- **conditions on relations**
with/without relations,
with appends, (need custom coding)
with distinct (columns from) relations,
has relations,
has distinct relations,
doesn't have relations,
relations OPTIMIZED filters (except morph relations),
- **custom NEW relations**
HasManySelfThroughSelf,
HasManyThrough2LinkTables,
HasManyThrough3LinkTables,
HasOneSelfThroughSelf,
HasOneThrough2LinkTables,
HasOneThrough3LinkTables,
- **MVCC DB "select count(*) from table" slow query solution in MySql >= 8**
In worst case scenario will estimate the count rather than execute the count without index filter
- **Prevent DB blocking via API with long running queries for mysql >= 5.7.4 and mariaDB >= 10.1.1**
#### II.7. Composite primary key
- using user defined separator (default _): 12_35
#### II.8. Sql debugging/logging
#### II.9. Error handling/logging
#### II.10. Datetime NOT timestamp for created_at and updated_at columns
#### II.11. Autocomplete on model properties
Also if autocomplete is needed on the model itself, them @ mixin can be added on the model:
Putting @ property on the model is less effective as opposed to this new Attribute class because of the public properties from eloquent model. Also it will avoid polluting the autocomplete with functions and properties from Eloquent model.
#### II.12. Read-only DTO for model
## III. Usage:
Changes required for the first resource on laravel 9 for example:
With green are the changes needed for a new resource (except ResourceController).
See [laravel 9 demo project that uses laravel-crud-wizard](https://github.com/macropay-solutions/laravel-crud-wizard-demo)
## IV. Try it:
Postman [collection](https://laravel-crud-wizard.com/laravel-10-crud-test.postman_collection.json). Please [contact us](https://macropay.net/contact/) for a bearer token.
The lib filtering capabilities (url query language) can be tested WITHOUT bearer token on [laravel 9 demo page](https://laravel-crud-wizard.com/laravel-9/laravel-lumen-crud-wizard) or [laravel 10 demo page](https://laravel-crud-wizard.com/laravel-10/laravel-lumen-crud-wizard)
Use our demo UI url query builder:
Note that the demo db has over 3.7 million operations.