PaginationX 1.0.1

PaginationX

Una librería ligera y fácil de usar para implementar paginación en aplicaciones .NET.

📋 Características

• ✅ Fácil de usar con LINQ y Entity Framework Core
• ✅ Clase PagedResult<T> con información completa de paginación
• ✅ Validación automática de parámetros de paginación
• ✅ Compatible con .NET 6.0 y superior
• ✅ Sin dependencias externas

📦 Instalación

Instala el paquete NuGet usando la CLI de .NET:

dotnet add package PaginationX

O a través del Package Manager Console en Visual Studio:

Install-Package PaginationX

🚀 Uso Rápido

Ejemplo Básico con Entity Framework Core

using PaginationX;
using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
    private readonly ApplicationDbContext _context;

    public ProductsController(ApplicationDbContext context)
    {
        _context = context;
    }

    [HttpGet]
    public async Task<ActionResult<PagedResult<Product>>> GetProducts(
        [FromQuery] PaginationRequest pagination)
    {
        // Obtener el total de registros
        var totalCount = await _context.Products.CountAsync();

        // Obtener los items paginados
        var items = await _context.Products
            .OrderBy(p => p.Name)
            .Skip((pagination.PageNumber - 1) * pagination.PageSize)
            .Take(pagination.PageSize)
            .ToListAsync();

        // Crear el resultado paginado
        var result = new PagedResult<Product>(
            items, 
            totalCount, 
            pagination.PageNumber, 
            pagination.PageSize
        );

        return Ok(result);
    }
}

Ejemplo con LINQ en Memoria

using PaginationX;

public class UserService
{
    private readonly List<User> _users;

    public PagedResult<User> GetUsers(PaginationRequest pagination)
    {
        var totalCount = _users.Count;

        var items = _users
            .OrderBy(u => u.LastName)
            .Skip((pagination.PageNumber - 1) * pagination.PageSize)
            .Take(pagination.PageSize)
            .ToList();

        return new PagedResult<User>(
            items, 
            totalCount, 
            pagination.PageNumber, 
            pagination.PageSize
        );
    }
}

Ejemplo con Filtros

[HttpGet("search")]
public async Task<ActionResult<PagedResult<Product>>> SearchProducts(
    [FromQuery] string searchTerm,
    [FromQuery] PaginationRequest pagination)
{
    var query = _context.Products.AsQueryable();

    // Aplicar filtros
    if (!string.IsNullOrEmpty(searchTerm))
    {
        query = query.Where(p => p.Name.Contains(searchTerm));
    }

    var totalCount = await query.CountAsync();

    var items = await query
        .OrderBy(p => p.Name)
        .Skip((pagination.PageNumber - 1) * pagination.PageSize)
        .Take(pagination.PageSize)
        .ToListAsync();

    var result = new PagedResult<Product>(
        items, 
        totalCount, 
        pagination.PageNumber, 
        pagination.PageSize
    );

    return Ok(result);
}

📖 Documentación de API

PaginationRequest

Clase para recibir parámetros de paginación desde el cliente.

Propiedades:

Ejemplo de Uso:

// En un controlador API
[HttpGet]
public IActionResult GetItems([FromQuery] PaginationRequest pagination)
{
    // pagination.PageNumber y pagination.PageSize están validados automáticamente
}

Ejemplo de Request desde Cliente:

GET /api/products?PageNumber=2&PageSize=20

PagedResult<T>

Clase que encapsula los resultados paginados con metadatos.

Propiedades:

Ejemplo de Response JSON:

{
  "items": [
    { "id": 11, "name": "Producto 11" },
    { "id": 12, "name": "Producto 12" }
  ],
  "currentPage": 2,
  "totalPages": 5,
  "pageSize": 10,
  "totalCount": 50,
  "hasPreviousPage": true,
  "hasNextPage": true
}

🎯 Ejemplos Avanzados

Método de Extensión para IQueryable

Puedes crear un método de extensión para simplificar aún más el uso:

public static class QueryableExtensions
{
    public static async Task<PagedResult<T>> ToPagedResultAsync<T>(
        this IQueryable<T> query,
        PaginationRequest pagination)
    {
        var totalCount = await query.CountAsync();

        var items = await query
            .Skip((pagination.PageNumber - 1) * pagination.PageSize)
            .Take(pagination.PageSize)
            .ToListAsync();

        return new PagedResult<T>(
            items,
            totalCount,
            pagination.PageNumber,
            pagination.PageSize
        );
    }
}

// Uso
var result = await _context.Products
    .OrderBy(p => p.Name)
    .ToPagedResultAsync(pagination);

Ejemplo con Automapper

[HttpGet]
public async Task<ActionResult<PagedResult<ProductDto>>> GetProducts(
    [FromQuery] PaginationRequest pagination)
{
    var totalCount = await _context.Products.CountAsync();

    var items = await _context.Products
        .OrderBy(p => p.Name)
        .Skip((pagination.PageNumber - 1) * pagination.PageSize)
        .Take(pagination.PageSize)
        .ProjectTo<ProductDto>(_mapper.ConfigurationProvider)
        .ToListAsync();

    var result = new PagedResult<ProductDto>(
        items,
        totalCount,
        pagination.PageNumber,
        pagination.PageSize
    );

    return Ok(result);
}

🔧 Prerrequisitos

• .NET 6.0 o superior

📄 Licencia

Este proyecto está licenciado bajo la Licencia MIT - ver el archivo LICENSE para más detalles.

🤝 Contribuciones

Las contribuciones son bienvenidas. Por favor, abre un issue o un pull request en el repositorio de GitHub.

👤 Autor

guevararogeljj

• GitHub: @guevararogeljj

📞 Soporte

Si tienes alguna pregunta o problema, por favor abre un issue en el repositorio de GitHub.