Download the PHP package shipsaas/laravel-resource-reducer without Composer
On this page you can find all versions of the php package shipsaas/laravel-resource-reducer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download shipsaas/laravel-resource-reducer
More information about shipsaas/laravel-resource-reducer
Files in shipsaas/laravel-resource-reducer
Package laravel-resource-reducer
Short Description Reduce fields & Fasten up your response size using Laravel Resource Reducer
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-resource-reducer
Laravel Resource Reducer from ShipSaaS
Ever thinking about how to speed up your application by optimizing the response? 👀
Laravel Resource Reducer helps you to optimize every API request by:
- Reduce the response's size, get what you need ⭐️
- Defer execution and allow on-demand data
- Responses to consumers faster 🚀
- No more BIG FAT JSON every item/request
- Computation only starts when requires, save CPU & memory 😎
- Built-in relationship access by using dot notation 👀
- Eager-loading on steroids (automated eager-loading, no more N+1 pain) 🔋
A simple yet super effective method to skyrocketing your API responding times 🥰
If you know about GraphQL, To query for data, we need to define which fields we want to retrieve. Laravel Resource Reducer is heavily inspired from GraphQL approach. ❤️
Supports
- Laravel 10 & 11
- PHP 8.2+
Compatibility
- Single Eloquent Model ✅
- Collection of Eloquent Models ✅
- Pagination ✅ (🟡 we have to use
Resource::collectionfor the time being) - (Planned) Collection of Arrays
- (Planned) Collection of Objects
Installation
Usage
Laravel Resource Reducer is the SuperSet from Laravel Resource, thus we can use the Reducer just like the way we use normal Resource.
For detailed documentation & best practices, check out: Reducer Documentation
Resource Class
Simply migrate your Resource class by extending ShipSaasReducer\Json\JsonReducerResource, implement the
definitions method.
The migration is 1:1 migration, no breaking changes 😉.
Remember to wrap your accessor in a Closure/Callable. This ensures computation won't start on Runtime (wait for the right time 😉).
NOTE: remember to remove the toArray() if you are migrating to JsonReducerResource 🥹, we handles magic there.
Return the data
Same as today as how we are using Laravel Resource:
From API consumers
Use the query _f or _fields, Reducer supports both ways:
http://api/users?_f=id,name,role.name,created_athttp://api/users?_fields[]=id,_fields[]=email
Testing
Run composer test 😆
Available Tests:
- Unit Testing
- Feature Testing
Contributors
- Seth Phat
Contributions & Support the Project
Feel free to submit any PR, please follow PSR-1/PSR-12 coding conventions and testing is a must.
If this package is helpful, please give it a ⭐️⭐️⭐️. Thank you!
License
MIT License
