Download the PHP package ashique-ar/laravel-crud-generator without Composer

Laravel CRUD Generator

A powerful, configuration-driven CRUD API generator for Laravel applications. Generate complete REST APIs with advanced features like permissions, filtering, sorting, validation, and custom business logic handlers - all through simple configuration.

✨ Features

• 🚀 Zero-Code CRUD APIs - Generate complete REST APIs through configuration
• 🔐 Permission Integration - Built-in support for Spatie Laravel Permission
• 🎯 Custom Logic Handlers - Extend with custom business logic easily
• 🔍 Advanced Filtering - Search across multiple fields with configurable operators
• 📊 Smart Sorting - Multi-field sorting with default configurations
• ⚡ Bulk Operations - Perform operations on multiple resources at once
• 🗑️ Soft Deletes Support - Full soft delete support with restore capabilities
• ✅ Automatic Validation - Validation rules defined in configuration
• 📚 API Documentation - Auto-generated OpenAPI/Swagger documentation
• 🛠️ Artisan Commands - Powerful commands for scaffolding and management
• 🧪 Fully Tested - Comprehensive test suite included

📋 Requirements

• PHP 8.1+
• Laravel 10.x | 11.x | 12.x
• Spatie Laravel Permission (automatically installed)

📦 Installation

Install the package via Composer:

Run the installation command:

This will:

• Publish the configuration file
• Set up middleware
• Register routes
• Generate initial permissions (optional)

🚀 Quick Start

1. Configure Your First Resource

Edit config/crud.php to define your resources:

2. Register Routes

Add the CRUD routes to your routes/api.php file:

3. Generate Permissions

4. Start Using Your API

Your CRUD endpoints are now available:

📖 Available Endpoints

For each configured resource, the following endpoints are automatically generated:

Query Parameters

Pagination

• page - Page number (default: 1)
• per_page - Items per page (default: 15, max: 100)

Search

• search - Search term across configured searchable fields
• search_operator - Search operator: like, exact, starts_with, ends_with (default: like)

Sorting

• sort - Field to sort by
• direction - Sort direction: asc or desc (default: asc)

Filtering

• filter[field] - Filter by specific field value
• filter[field][operator] - Filter with specific operator (=, !=, >, <, >=, <=, like, in, between)

🔧 Advanced Usage

Model Namespacing

The package supports flexible model namespacing to accommodate different project structures:

When using artisan commands, you can specify models in several ways:

Custom Logic Handlers

Create custom business logic for your resources:

This generates:

Then update your configuration:

Adding New Resources

Use the artisan command to quickly add new resources:

This will interactively help you configure:

• Model class and table
• Fillable fields
• Validation rules
• Search and sort configuration
• Permissions
• Relations
• Custom logic handler (optional)

Bulk Operations

Perform operations on multiple resources:

Permissions

The package integrates seamlessly with Spatie Laravel Permission:

API Documentation

Access auto-generated documentation:

Returns OpenAPI 3.0 compatible JSON that can be used with Swagger UI or similar tools.

📝 Configuration

The package uses a comprehensive configuration system in config/crud.php. Here's a complete reference:

Global Configuration

Resource Configuration Options

Each resource supports the following configuration options:

Validation Rule Placeholders

In validation rules, you can use placeholders that will be replaced during validation:

• {{id}} - The ID of the current resource (useful for unique rules in updates)
• {{user_id}} - The ID of the authenticated user
• {{resource}} - The name of the current resource

Example:

🧪 Testing

Run the package tests:

Run tests with coverage:

📝 Configuration

See the Configuration Guide for detailed configuration options.

🔄 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.

📄 License

The MIT License (MIT). Please see License File for more information.

🙏 Credits

• Your Name
• All Contributors

💡 Support

• Documentation
• Issues
• Discussions

Made with ❤️ for the Laravel community