naranarethiya/model-resource-generator

Automatically generate API resource classes for your Laravel models, simplifying the process of transforming your models into API resources with ease.

0.0.3 2024-08-06 18:24 UTC

Requires

• laravel/framework: ^8.0|^9.0|^10.0|^11.0

Requires (Dev)

• larastan/larastan: ^2.0
• laravel/pint: ^1.17
• orchestra/testbench: ^9.2

MIT

• Naran Arethiya

README

model-resource-generator is a custom Laravel command that generates API resource classes for all available models in your Laravel application. It includes the existing columns and relations of each model in the generated resource classes.

It respects your model's hidden attributes and does not load any relations automatically. It adjusts the API attributes based on whether relations are loaded or not.

Installation

You can install the package via composer:

composer require naranarethiya/model-resource-generator

Usage

To generate API resources for models located in the app/Models directory:

php artisan generate:api-resources

To specify a different directory or a single model file:

php artisan generate:api-resources --model-path=app/CustomModels

Options

--model-path (optional): Specify the directory path to search for models or a single model file path. If not provided, it defaults to app/Models

Features

• Automatically generates API resource classes for each model found in the specified directory.
• Includes existing columns and relations in the generated resource classes.
• Exclude all hidden attributes
• Provides an option to overwrite existing resources or skip them.
• Outputs a summary of the generated, skipped, and overwritten resources.

Contributing

Contributions are welcome! Please submit a pull request or open an issue to suggest changes or report problems.

License

This package is open-source software licensed under the MIT license.