Download the PHP package grantholle/api-resource-detection without Composer
On this page you can find all versions of the php package grantholle/api-resource-detection. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download grantholle/api-resource-detection
More information about grantholle/api-resource-detection
Files in grantholle/api-resource-detection
Package api-resource-detection
Short Description Detect API Resources for your Eloquent models.
License MIT
Informations about the package api-resource-detection
API Resource Detection
This package provides a trait to add to your Eloquent models to get automatic API Resource detection.
Installation
Usage
You generate resources for your models by using the php artisan make:resource
command. This will create a resource in your app/Http/Resources
directory. This package detects different naming conventions. You can name your resources the same as your model or name it using the Resource
suffix, like ModelResource
In your models that have resources, you can add the HasResource
trait.
Assume we have a resource named UserResource
.
Let's add the trait to the User
model:
Now when you want to get the resource for the model, you can call toResource()
on the model instance to detect and retrieve the API resource for the model.
You can also use the alternative syntax of Model::resource()
.
This also works for collection of models.
This will automatically look for a UserCollection
or UserCollectionResource
resource class. If none is found it will default to calling the collection()
function on the standard resource class.
If your application has a different namespace other than the default resource namespace, you can tell it to use a different namespace for your resources.
In a service provider,
You can also change how the resources is guessed and return a new class name based on the model. By default, it looks for your model name or model name with the Resource
suffix in the default resource namespace. You can also customize how collections are resolved.
All versions of api-resource-detection with dependencies
illuminate/database Version ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0