Garnet.Pagination 0.1.2

Garnet Pagination

Dotnet library to facilitate applying pagination along with filtering and ordering to a list of objects.

Garnet.Standard.Pagination

dotnet add package Garnet.Standard.Pagination

The idea behind standard packages is not to mess with the domain or application layer with implementation details and keep it clean.

Therefore Garnet.Standard packages consists of abstractions.

Garnet.Pagination

dotnet add package Garnet.Pagination

Implementation of the Garnet.Standard.Pagination

Register to DI container

To use with default configurations:

services.AddGarnetPagination();

Customer configurations can be used either from IConfiguration or directly passing configurations objects to other overloads methods.

Garnet.Detail.Pagination.Asp

dotnet add package Garnet.Detail.Pagination.Asp

Facilitates using pagination in web application projects by enabling getting pagination requests as an action input and response the result after applying the pagination.

Register to DI container

To use with default configurations:

services.AddGarnetPaginationAsp();

Custom configurations can be used either from IConfiguration or directly passing configurations objects to other overloads methods.

services.AddGarnetPaginationAsp(configuration);

Or

services.AddGarnetPaginationAsp(paginationConfig: new PaginationConfig
    {
        DefaultPageSize = 20
    },
    paginationAspRequestConfig: new PaginationAspRequestConfig
    {
        FilterParameterName = "filter",
        OrderParameterName = "order"
    });

Using in the action

[Route("[controller]")]
public class MyController : ApiController
{
    [HttpGet]
    public ActionResult<IReadOnlyList<ObjectDto>> GetAll([FromQuery] IPagination pagination)
    {  
        IPagedElements<object> objects = _objectRepository.GetAll(pagination);

        return objects.ToPaginationWithHeaderObjectResult();
    }
}

http://localhost/api/my?page=1&&size=10&&filter=prop1==value&&order=id:ASC

ToPaginationWithHeaderObjectResult() extension method returns an ObjectResult with the list of elements and header field for total number of elements

Garnet.Detail.Pagination.ListExtensions

dotnet add package Garnet.Detail.Pagination.ListExtensions

Some extension methods to use over IQueryable<T> or IList<T>

This is using Dynamic Linq library for filtering and ordering which means nested property ( by dot '.') filtering or ordering is also supported like filters=prop1.prop2==value

IQueryable<Model> model = _modelRepository.GetModels();

IPagedElements<Model> pagedModel = await model.ToPagedResultAsync();

Configure

Use either of UseGarnetPaginationIQueryable overload methods to get required configurations objects from DI already registered or pass instantly.

applicationBuilder.UseGarnetPaginationListExtensions();

IIQueryableAsyncMethods

Implement this interface to use IQueryable async extension methods from other libraries like EntityFramework

public class EfIQueryableAsyncMethods : IIQueryableAsyncMethods
{
    public Task<List<TElement>> ToListAsync<TElement>(IQueryable<TElement> queryable)
    {
        return queryable.ToListAsync();
    }

    public Task<long> LongCountAsync<TElement>(IQueryable<TElement> queryable)
    {
        return queryable.LongCountAsync();
    }
}

applicationBuilder.UseGarnetPaginationListExtensions(new EfIQueryableAsyncMethods());

Default Configs

PaginationConfig

PaginationFilterConfig

PaginationOrderConfig

PaginationAspRequestConfig

PaginationAspResponseConfig