Download the PHP package dev-toolbelt/laravel-fast-crud without Composer

Laravel Fast CRUD

A powerful Laravel package for rapid CRUD API scaffolding. Build complete RESTful APIs in minutes with minimal boilerplate, following best practices and the JSend specification.

Features

• Works exclusively with Laravel 11+
• 9 pre-built actions (Create, Read, Update, Delete, Soft Delete, Restore, Search, Options, Export CSV)
• 14+ search operators for flexible filtering (eq, like, between, in, json, etc.)
• Multi-field term search via filter[term] with database-aware LIKE/ILIKE
• Built-in validation using Laravel's validation rules
• Automatic route registration with permission middleware support
• Hook system for customization without overriding entire methods
• Global and per-action configuration
• Soft delete with audit trail (who deleted and when)
• CSV export with custom column mapping and dot notation support
• Consistent API responses following JSend specification

Requirements

• PHP ^8.2
• Laravel ^11.0

Installation

Publish the configuration (optional):

Quick Start

1. Create a Controller

2. Register Routes

That's it! You now have a complete CRUD API.

Available Actions

Note: The Options route (GET /options) has no permission middleware and is always publicly accessible (subject to any other middleware applied to the surrounding route group). This makes it easy to populate HTML <select> fields and dropdowns without requiring the user to have explicit permissions.

Search Operators

Filter your data with powerful operators via query string:

Term Search

In addition to operator-based filters, Search supports a configurable term filter that matches multiple fields using LIKE (MySQL/SQLite) or ILIKE (PostgreSQL).

Usage

Controller Configuration

Query Generated (Example)

For PostgreSQL, filter[term]=john with the fields above generates a query equivalent to:

Custom Term Key

Sorting

Sort by one or multiple fields (prefix with - for descending):

Pagination

Available Hooks

Customize behavior by overriding hooks in your controller:

Hook Examples

Validation

The package provides built-in validation using Laravel's validation system. Define rules by overriding createValidateRules() or updateValidateRules() methods.

Validation Error Response

When validation fails, a 400 response is returned with detailed error information:

Each error includes:

• field: The field that failed validation
• error: The rule name (e.g., required, email, max, unique)
• value: The submitted value
• message: Laravel's validation message

For detailed validation documentation, see:

• Create Action - Validation
• Update Action - Validation

Configuration

Configurable HTTP Status Codes

Each action supports a configurable http_status option to customize the HTTP status code returned on successful responses:

Validation Error HTTP Status

All validation errors (empty payload, invalid UUID, required field, column not found) use the global.validation.http_status configuration:

To return a different status code for validation errors:

Available status codes are defined in the DevToolbelt\Enums\Http\HttpStatusCode enum.

Selective Route Registration

Include or exclude specific actions:

CSV Export

Configure CSV export with custom columns and nested relationships:

API Response Format

All responses follow the JSend specification:

Success Response:

Success with Pagination:

Fail Response (client error):

Empty Payload Error:

Invalid UUID Error:

Documentation

Detailed documentation for each component:

Core:

• Router - Route registration and permission middleware

Actions:

• Create Action
• Read Action
• Update Action
• Delete Action
• Soft Delete Action
• Restore Action
• Search Action
• Options Action
• Export CSV Action

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Development Setup

Code Quality Requirements

Pull Request Guidelines

Before submitting a PR, ensure:

1. All tests pass: composer test
2. Coverage is at least 85%: composer test:coverage
3. Code style is correct: composer phpcs
4. No static analysis errors: composer phpstan

Important: Pull requests with coverage below 85% will be automatically blocked by CI.

Coverage Report

• Dashboard: Codecov
• HTML Report: GitHub Pages

License

MIT License. See LICENSE for details.