WM.QueryFilters 1.0.7

QueryFilters

QueryFilters — це бібліотека для фільтрації та пагінації даних у .NET, яка дозволяє легко інтегрувати запити з фільтрами, сортуванням і розбиттям на сторінки у ваших API.

📦 Встановлення

Ви можете встановити пакет через NuGet:

Install-Package QueryFilters

Або через .NET CLI:

dotnet add package QueryFilters

🚀 Використання

1. Додавання атрибута AllowedQueryFilters

Додавайте атрибут [AllowedQueryFilters] до ваших API-ендпоінтів, щоб автоматично обробляти фільтри:

[HttpGet]
[AllowedQueryFilters]
public ActionResult<PaginatedDto<CustomerDTO>> GetCustomers(
    [FromQuery] int page = 1,
    [FromQuery] int pageSize = 10,
    [FromQuery] string? sortField = null,
    [FromQuery] bool sortDescending = false)
{
    var result = _customerService.GetCustomers()
        .PaginateAndFilterData(QueryFilters, page, pageSize, sortField, sortDescending);
    
    return Ok(new PaginatedDto<CustomerDTO>() 
    { 
        TotalCount = result.TotalCount, 
        Data = result.Data.Select(c => new CustomerDTO(c)) 
    });
}

2. Використання QueryFilters у базовому контролері

Щоб зручно використовувати QueryFilters у всіх контролерах, можна створити базовий клас контролера:

using Microsoft.AspNetCore.Mvc;

public abstract class BaseController : ControllerBase
{
    protected Dictionary<string, string> QueryFilters =>
        HttpContext.Items["filters"] as Dictionary<string, string> ?? new Dictionary<string, string>();
}

Це дозволяє легко отримувати фільтри у похідних контролерах без зайвого коду.

3. Використання методу PaginateAndFilterData

Метод PaginateAndFilterData дозволяє:

• Застосовувати фільтрацію згідно з переданими параметрами.
• Сортувати дані за вказаним полем.
• Пагінувати результати.

var result = _customerService.GetCustomers()
    .PaginateAndFilterData(QueryFilters, page, pageSize, sortField, sortDescending);

4. Використання методу FilterData

Якщо вам не потрібна пагінація, а тільки фільтрація та сортування, використовуйте FilterData:

var result = _customerService.GetCustomers()
    .FilterData(QueryFilters, sortField, sortDescending);

Метод FilterData повертає:

• TotalCount — загальну кількість елементів після фільтрації.
• Data — відфільтровані та відсортовані елементи.

public static (int TotalCount, IEnumerable<T> Data) FilterData<T>(this IQueryable<T> sourceData,
    Dictionary<string, string> filters = null,
    string sortField = null,
    bool sortDescending = false)

📌 Переваги

✅ Легка інтеграція. ✅ Підтримка динамічних фільтрів. ✅ Гнучке сортування та пагінація. ✅ Мінімум конфігурації.

🔗 Ліцензія

Цей пакет розповсюджується за ліцензією MIT. Вільний для використання у комерційних і відкритих проєктах.

📢 Якщо у вас є питання або пропозиції, відкривайте issue на GitHub або надсилайте PR!