Reo.Core.DataModels 6.0.428

Reo.Core.DataModels

Описание пакета

Reo.Core.DataModels — это библиотека, предназначенная для упрощения работы с запросами и ответами в приложениях на C#. Пакет предоставляет набор универсальных интерфейсов и классов для реализации пагинации, фильтрации, сортировки и агрегации данных. Он позволяет разработчикам быстро создавать структуры данных, которые можно использовать в REST-сервисах, API и других сценариях, где требуется обработка запросов и ответов.

Основные функции:

• Поддержка пагинации (Take/Skip).
• Реализация фильтрации данных через интерфейсы IFilteredRequest<TFilter>.
• Сортировка данных с использованием ISortedRequest.
• Агрегация данных через IAggregatedRequest.
• Гибкая интеграция с другими библиотеками (например, FluentValidation для валидации).

Основные компоненты

1. ISortedRequest

Интерфейс для работы с параметрами сортировки. Содержит коллекцию полей OrderByField, которые определяют порядок сортировки данных.

2. IFilteredRequest<TFilter>

Интерфейс для фильтрации данных. Использует модель TFilter, которая может быть настроена под конкретные требования приложения.

3. IPaginatedRequest

Интерфейс для пагинации. Определяет параметры Take (количество элементов на странице) и Skip (смещение для пропуска элементов).

4. IAggregatedRequest

Интерфейс для агрегации данных. Содержит список полей AggregationFields, которые используются для вычисления итоговых значений.

5. PaginatedRequest<TFilter>

Класс, реализующий IPaginatedRequest и IFilteredRequest<TFilter>. Объединяет параметры пагинации и фильтрации в одном объекте.

6. NonPaginatedRequest<TFilter>

Класс для запросов без пагинации. Реализует только IFilteredRequest<TFilter>.

7. CheckResult (в ResponseModels)

Модель ответа, используемая для передачи результатов проверки или операций. Содержит флаг успеха и сообщение.

Требования

Совместимость с .NET

• .NET Standard 2.1
• .NET 8.0

Зависимости

• Microsoft.CSharp
• NEST (для работы с Elasticsearch)
• Newtonsoft.Json
• System.ComponentModel.Annotations
• System.Collections.Immutable
• FluentValidation

Установка

NuGet Package Manager

Install-Package Reo.Core.DataModels

.NET CLI

dotnet add package Reo.Core.DataModels

Настройка

Регистрация в DI-контейнере (ASP.NET Core)

Если пакет используется в приложении ASP.NET Core, зарегистрируйте модели и сервисы в Startup.cs или Program.cs:

services.AddDataModels(); // Если требуется, добавьте кастомные настройки

Примечание: В данном пакете не требуется специфичная конфигурация. Все модели и интерфейсы готовы к использованию без дополнительных настроек.

Использование

Пример 1: Пагинация и фильтрация

var request = new PaginatedRequest<MyFilter>
{
    Filter = new MyFilter { Name = "Test" },
    Take = 10,
    Skip = 0
};

Пример 2: Сортировка

var sortedRequest = new SortedRequest
{
    OrderByFields = new List<OrderByField>
    {
        new OrderByField { Field = "Name", Direction = "asc" }
    }
};

Пример 3: Агрегация

var aggregatedRequest = new AggregatedRequest
{
    AggregationFields = new List<string> { "TotalSales", "Count" }
};

Пример 4: Использование CheckResult в ответе

public CheckResult ValidateData()
{
    if (data.IsValid)
        return new CheckResult { Success = true, Message = "Данные валидны" };
    else
        return new CheckResult { Success = false, Message = "Ошибка валидации" };
}

Лицензия

Reo.Core.DataModels распространяется под лицензией MIT License. См. файл LICENSE для получения подробной информации.