Laravel Magic
Laravel Magic provides Abstract Controller, Model, generic Request, Traits, Exceptions and various middlewares in order to generate very easily and quickly API resources from scratch.
Support us
Laravel Magic is a free open source project. If you use the project, please star us on Github... it costs nothing but a click!
Installation
You can install the package via composer:
composer require dominiquevienne/laravel-magic
This package does not provide
- any migration
- any configuration file
- any view
Usage
Models
Extending your models from AbstractModel will give you the opportunity to get the autocompletion that comes with PHPDoc in your IDE and will make it possible to check if a relationship exist for the given model.
It will also make it possible for AbstractController to make the magic happen. (see Controllers).
namespace App\Models;
use Dominiquevienne\LaravelMagic\Models\AbstractModel;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
/**
* @property-read int $id
* Your PHPDoc goes here
*/
class YourModel extends AbstractModel
{
use HasFactory;
protected $fillable = [
// ...
];
}
Controllers
Extending your controllers from AbstractController will give you the opportunity to get a fully automated way to generate index, show, destroy, update, store methods without writing a single controller line. This will fill 90% of the API Resource needs.
Since default methods are already available in AbstractController, you can directly configure your routes to target the usual methods and magic will happen.
namespace App\Http\Controllers;
use Dominiquevienne\LaravelMagic\Http\Controllers\AbstractController;
class YourController extends AbstractController
{
}
Relationships
When calling an index or show endpoint, you can add the with GET parameter in order to retrieve direct relationships of a given model. The API will not throw an error / warning if relationship is not available.
If the property is not provided or if value is empty after sanitization, the query will result in a normal query without any relationship retrieval.
Fields
When calling an index or show endpoint, you can add the fields GET parameter in order to only retrieve the listed fields. The API will not throw an error / warning if field is not available.
If the property is not provided or if value is empty after sanitization, the query will throw every available fields.
Filtering
When calling an index endpoint, you can add the filter GET parameter in order to filter the list so you only retrieve the row you targeted. The API will not throw an error / warning if the fields you use for filtering are not available.
If the property is not provided or if value is empty after sanitization, the query will result in a normal query retrieving all the rows.
Ordering
When calling an index endpoint, you can add the filter GET parameter in order to order the provided result is ordered the way you need.
The API will throw an error if you provide a non compliant string.
If the property is not provided, the query will result in a normal query retrieving all the rows without any specific sorting.
Pagination
The standard Laravel pagination is integrated. Please refer to the official paginate documentation.
Requests
Laravel Magic provides a BootstrapRequest file which will be call on any AbstractConctroller.create and AbstractConctroller.update methods. If a request which name is ModelnameRequest is available in your Requests folder, it will be used to generate the validation rules.
Middlewares
Laravel Magic provides ForceJson and VerifyJwtToken middlewares. Those can be set up in Laravel Kernel.
Traits
We also provide a HasPublicationStatus trait. To use the trait, add it to your models and migrate your schema so it has the publication_status_id field. Value of this field is handled by $publicationStatusAvailable property.
Exceptions
Laravel Magic provides those Exceptions:
- ControllerAutomationException
- EnvException
- PublicationStatusException
- StatusUnknownException
These are used internally but you can of course use them as you want.
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.
3 Sep 20, 2022
191 Dec 30, 2022
12 Nov 24, 2022
19 Sep 8, 2022
215 Dec 29, 2022
147 Dec 30, 2022
11 Sep 7, 2022
347 Dec 25, 2022
108 Dec 11, 2022
7 Nov 23, 2022
6 Jul 26, 2021
5 Aug 12, 2022
2 Nov 9, 2021
3 Jul 30, 2022
30 Dec 24, 2022
301 Nov 25, 2022
54 Sep 21, 2022
59 Mar 31, 2022