Official Documentation: Laravel Query Engine

Welcome to the detailed documentation for victormgomes/laravel-query-engine. This package is an advanced API filtering and sorting engine for Laravel, fully secure and aware of your database schema.

📚 Table of Contents

Getting Started

• Introduction Why this package exists and its core features.
• Installation & Quick Start How to install and immediately start using the package.
• Package Comparison (vs Spatie) An architectural comparison with spatie/laravel-query-builder.

Usage

• URL Syntax & Basic Filters Learn how to pass parameters, JSON vs Arrays, and the supported operators.
• Available Model Methods Documentation of the methods injected into your Eloquent models (e.g. paginateQuery).
• Advanced Usage (Attributes & Scopes) Discover how to expose Local Scopes, Accessors ($appends), and Aggregations (counts).
• Global Configuration & Security Understand how the package protects your API and how to change the default behavior of pagination and filters.