PHPackages bjerke/laravel-bread - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [HTTP & Networking](/categories/http) 4. / 5. bjerke/laravel-bread ActiveLibrary[HTTP & Networking](/categories/http) bjerke/laravel-bread ==================== A boilerplate package for BREAD operations through REST API in Laravel v4.0.1(3y ago)115.2k2[1 issues](https://github.com/jesperbjerke/laravel-bread/issues)[1 PRs](https://github.com/jesperbjerke/laravel-bread/pulls)MITPHPPHP ^8.0 Since Jun 24Pushed 3y ago2 watchersCompare [ Source](https://github.com/jesperbjerke/laravel-bread)[ Packagist](https://packagist.org/packages/bjerke/laravel-bread)[ RSS](/packages/bjerke-laravel-bread/feed)WikiDiscussions master Synced yesterday READMEChangelog (10)Dependencies (6)Versions (23)Used By (0) Laravel Bread ============= [](#laravel-bread) A library to easily handle BREAD (Browse, Read, Edit, Add, Delete) operations through a JSON Rest API. Define model definitions, performs validations and provides default controller routes. This package makes use of the API Query Builder from Installation ------------ [](#installation) ``` composer require bjerke/laravel-bread ``` ### Configuration [](#configuration) There is not much to configure, but one thing that can be configured is what namespace to use for your models (used when trying to lookup the model in the controller). It is preconfigured to use `\App\Models\`. If you don't need to change any of the default configuration options there's no need to publish this configuration. If you do want to change the default namespace however, you need to publish the configuration file from this library so you can change it in your own application. To do this run the following artisan command: ``` php artisan vendor:publish --provider="Bjerke\Bread\BreadServiceProvider" ``` You will now have a `bread.php` config file in `/config` where you can change the configuration values. Other configuration items are default field groups available to all models as well as some options related to TUS uploads. Usage ----- [](#usage) To start using this package, you need to create your own controller class, name it in singular matching the model it's affecting. For example `UserController` will lookup the `User` model automatically. If you don't follow this pattern, you can define the `$modelName` property on the controller. Extend your controller on `BreadController` from this package. Then in your model, use the `QueryBuilderModelTrait` and `BreadModelTrait`. Lastly, define the API endpoints in your router. ``` Route::get('definition', [UserController::class, 'definition']); // Fetch model field definitions Route::get('', [UserController::class, 'index']); // Query multiple users, uses ApiQueryBuilder Route::post('', [UserController::class, 'create']); // Create new user Route::get('{id}', [UserController::class, 'view']); // Fetch single user Route::patch('{id}', [UserController::class, 'update']); // Update user Route::delete('{id}', [UserController::class, 'delete']); // Delete user Route::delete('{id}/detach/{relatedModel}', [UserController::class, 'detach']); // Attach an existing model to be related to user Route::put('{id}/attach/{relatedModel}', [UserController::class, 'attach']); // Detach an existing related model from user // If you want to use TUS uploads add this route Route::any('tus/{chunkId?}', [UserController::class, 'tus']); // Handle TUS uploads ``` Remember to only define the endpoints that you actually want to use. And set proper authentication and authorization rules. If you want to provide field definitions and automatic validation etc, you need to use the `FieldDefinition` trait and define the fields on your model. ``` class User { use FieldDefinition; use QueryBuilderModelTrait; use BreadModelTrait; protected function define(DefinitionBuilder $definition): DefinitionBuilder { $definition->addFields([ (new TextField('first_name'))->label(Lang::get('fields.first_name'))->required(true), (new TextField('last_name'))->label(Lang::get('fields.last_name'))->required(true), (new EmailField('email')) ->label(Lang::get('fields.email')) ->required(true) ->addValidation('unique:users,email' . (($this->exists) ? (',' . $this->id) : '')) ]); return $definition; } } ``` The above definition together with the routes will allow you to post the following to `/users` to create a new user: ``` { "data" : { "first_name" : "John", "last_name" : "Doe", "email" : "john.doe@test.com" } } ``` Note the data you send is expected to be within the `data` property. More about available field types and how they work is described in each fields docblock in `src/Traits/FieldDefinition.php`. ### Modifying queries in BREAD controller endpoints [](#modifying-queries-in-bread-controller-endpoints) You can hook into the query builder and append your own rules on endpoints that fetch data from the database. Example: ``` class ProductController extends BreadController { public function index(Request $request, $applyQuery = null) { return parent::index($request, static function (Builder $query) { $query->where('distributor_id', \Auth::user()->distributor_id); }); } } ``` ### Run logic before/after Updating/Deleting/Attaching/Detaching [](#run-logic-beforeafter-updatingdeletingattachingdetaching) The breadcontroller provides hooks to allow you to run custom logic before the actual saving proceeds. If you want to stop the execution, throw an appropriate exception. Use the hooks by implementing the endpoint method in your controller, and passing a closure to the parent method. This works on all endpoint methods. Example: ``` class ProductController extends BreadController { public function update(Request $request, $id, $with = [], $applyQuery = null, $beforeSave = null) { /* @var Product $product */ $product = parent::update($request, $id, $with, $applyQuery, static function (Product $product) { // Set a custom property on the model before saving $product->last_updated_by = \Auth::id(); }); return $product; } } ``` ### Saving files/images [](#saving-filesimages) In order for the built-in functionality of storing files and/or images, this package requires the to be installed and configured. Add files/images: ``` { "data" : { "files" : [{ "base64" : "base64 encoded string representation of the image/file", "name" : "Filename", "add" : true }] } } ``` Remove files/images: ``` { "data" : { "files" : [{ "id" : 1, "remove" : true }] } } ``` ### TUS uploads [](#tus-uploads) There is build in functionality to support uploads using the [TUS protocol](https://tus.io/). To enable TUS uploads, you need to install the package in addition to the media library package specified above. You can then use a TUS client like or . When submitting the files, you send the unique upload key received from the TUS server (a UUID4 string) instead of base64. Note that it is expected that the file has already been uploaded through TUS and exists on the server before this request is sent. ``` { "data" : { "files" : [{ "tusKey" : "002f12d4-6949-4266-af06-675f653c0bdc", "name" : "Filename", "add" : true }] } } ``` #### Cleaning orphaned TUS files [](#cleaning-orphaned-tus-files) Add `$schedule->command('bread:clean-tus --force')->daily()` to your scheduler to automatically clean up orphaned/aborted files. ### Health Score 35 — LowBetter than 80% of packages Maintenance18 Infrequent updates — may be unmaintained Popularity26 Limited adoption so far Community9 Small or concentrated contributor base Maturity70 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~39 days Recently: every ~51 days Total 22 Last Release 1322d ago Major Versions v1.11.1 → v2.0.02021-04-04 v2.1.0 → v3.0.02021-08-12 v3.2.3 → v4.0.02022-09-13 PHP version history (3 changes)v1.8.0PHP >=7.2 v2.0.0PHP ^7.4 || ^8.0 v3.0.0PHP ^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/1756908bb0103b783e0cb8fec49678e73ad98ff698a7889b783f10dbc2e0b988?d=identicon)[jesperbjerke](/maintainers/jesperbjerke) --- Top Contributors [![jesperbjerke](https://avatars.githubusercontent.com/u/5323483?v=4)](https://github.com/jesperbjerke "jesperbjerke (38 commits)") --- Tags apilaravelrestormeloquentquerycrudbreadjesperbjerke ### Embed Badge ![Health badge](/badges/bjerke-laravel-bread/health.svg) ``` [![Health](https://phpackages.com/badges/bjerke-laravel-bread/health.svg)](https://phpackages.com/packages/bjerke-laravel-bread) ``` ### Alternatives [bjerke/api-query-builder A query builder for Laravel that parses the request and uses Eloquent ORM to query database 267.7k1](/packages/bjerke-api-query-builder)[api-platform/laravel API Platform support for Laravel 59126.4k6](/packages/api-platform-laravel)[illuminatech/data-provider Allows easy build for DB queries from API requests 4413.3k](/packages/illuminatech-data-provider)[dragon-code/laravel-http-logger Logging incoming HTTP requests 319.8k3](/packages/dragon-code-laravel-http-logger) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)