alibori / laravel-api-resource-generator
Package to generate API resources from models.
Installs: 1 374
Dependents: 0
Suggesters: 0
Security: 0
Stars: 19
Watchers: 1
Forks: 2
Open Issues: 0
Requires
- php: >=8.1
- barryvdh/reflection-docblock: ^2.1
- doctrine/dbal: ^2.9|^2.10|^3.0
- illuminate/console: ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
- illuminate/database: ^9.1|^9.2|^10.0|^11.0
- illuminate/filesystem: ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
- illuminate/support: ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
Requires (Dev)
- laravel/pint: ^1.6
- orchestra/testbench: ^7.22|^8.11|^9.0
- pestphp/pest: ^1.22
- pestphp/pest-plugin-laravel: ^1.4
README
This package will help you to generate API resources for your Laravel project.
Installation
You can install the package via composer:
composer require alibori/laravel-api-resource-generator --dev
Usage
All you need to do is run the following command:
php artisan api-resource:generate <model-name>
If you want to generate multiple resources at once, you can pass multiple model names separated by a comma:
php artisan api-resource:generate <model-name>,<model-name>,<model-name>
This command will generate a new resource for the given model/s name/s with the properties defined in the model.
If you want to set the array keys of the resource as camelCase, you will be prompted to do it.
For example, for the model named User
you will get the following resource:
<?php namespace App\Http\Resources; use Illuminate\Contracts\Support\Arrayable; use Illuminate\Http\Request; use Illuminate\Http\Resources\Json\JsonResource; use JsonSerializable; /** * Resource generated by alibori/laravel-api-resource-generator * * @property integer $id * @property string $name * @property string $email * @property string $email_verified_at * @property string $password * @property string $remember_token * @property string $created_at * @property string $updated_at */ class UserResource extends JsonResource { /** * Transform the resource into an array. * * @param Request $request * @return array|Arrayable|JsonSerializable */ public function toArray($request): array|JsonSerializable|Arrayable { return [ 'id' => $this->id, 'name' => $this->name, 'email' => $this->email, 'email_verified_at' => $this->email_verified_at, 'remember_token' => $this->remember_token, 'created_at' => $this->created_at, 'updated_at' => $this->updated_at ]; } }
Publish config file
If you want to publish the config file to change the default namespace for the generated resources and the directory where the resources will be generated, you can run the following command:
php artisan vendor:publish --provider="Alibori\LaravelApiResourceGenerator\LaravelApiResourceGeneratorServiceProvider" --tag="config"