https://github.com/baethon/laravel-resource
Conveniant factory for Laravel API resources
https://github.com/baethon/laravel-resource
api http laravel resource resources
Last synced: 25 days ago
JSON representation
Conveniant factory for Laravel API resources
- Host: GitHub
- URL: https://github.com/baethon/laravel-resource
- Owner: baethon
- License: mit
- Created: 2021-03-27T11:25:21.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-05T14:37:46.000Z (over 2 years ago)
- Last Synced: 2025-04-09T21:09:00.582Z (about 1 month ago)
- Topics: api, http, laravel, resource, resources
- Language: PHP
- Homepage:
- Size: 170 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# baethon/laravel-resource
The package provides a convenient factory function for [Laravel API Resources](https://laravel.com/docs/8.x/eloquent-resources). Based on the given model, it will try to find the corresponding API resource and return it. If the resource doesn't exist, it will use the base `JsonResource` class. It works with collections.
## Installation
```
composer require baethon/laravel-resource
```
## Example usage
```php
resource($this->whenLoaded('tags')),
];
}
}
```
## How it works?
The package tries to follow the Laravels naming conventions. When creating a resource for `User` model, it will look for `UserResource`. When passing a collection of `User` instances, it will look for `UserResourceCollection` or `UserCollection`.
In the case of collections, the package won't wrap individual models in their respective resources. It will pass that responsibility to the collection resource instead.
## Rationale
When you decide to use API resources, you should create an individual resource for each model returned by the API. In many cases, they're not extended in any way, and it seems pointless to create a bunch of empty classes.
To avoid this, you might use the `JsonResource` for the "generic" models and create resources only for those models that include any logic. However, when the time comes to make a customized resource for one of the models, you'll have to update all the places where you previously used the `JsonResource`.
This is the moment when `resource()` shines. You simply need to create the customized resource, and the factory will automatically start using it instead of the base resource.
## Customization
There are two ways to customize the factory:
1. custom map
1. custom naming strategy
To change any of them, you'll have to publish the config files:
```
php artisan vendor:publish --provider="Baethon\Laravel\Resource\ServiceProvider"
```
## License
The package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).