RzR.ResultMessage.Pagination.AspNetCore 4.0.0.7837

RzR.ResultMessage.Pagination.AspNetCore

ASP.NET Core integration for RzR.ResultMessage.Pagination.EntityFrameworkCore. Adds a base controller, query-string model binding, minimal-API binders (.NET 7+), standard pagination headers, an allow-list registry, RFC 9457 ProblemDetails on the failure path, and an OpenAPI convention that auto-annotates paged endpoints.

Targets: netstandard2.1, net5.0, net6.0, net7.0, net8.0, net9.0. Minimal-API helpers are gated to .NET 7+.

Install

Install-Package RzR.ResultMessage.Pagination.AspNetCore

What you get

• BaseApiPagedResultController with PagedOkResult<T> / PagedXmlResult<T>.
• [FromPagedQuery] MVC model binder for PagedRequest / PageRequestWithFilters.
• PagedQuery<T> / PagedQueryWithFilters<T> minimal-API wrappers (.NET 7+).
• WithPagedResult() endpoint filter and ToPagedHttpResult adapter.
• Headers: X-Total-Count, X-Page-Count, X-Page-Size, X-Current-Page, RFC 5988 Link (GET only), Server-Timing: paged;dur=<ms> (opt-in).
• Per-entity allow-list via ConfigurePageable<T>(b => b.AllowSort(...).AllowFilter(...).AllowSearch(...)).
• OpenAPI convention via AddPagedListResultApiExplorer().

Setup

builder.Services
    .AddControllers()
    .AddPagedListResultApiExplorer();

builder.Services
    .AddPagedListResultWeb(o =>
    {
        o.MaxPageSize = 100;
        o.DefaultPageSize = 25;
    })
    .ConfigurePageable<Product>(p =>
    {
        p.AllowSort("Id", "Name", "Price", "CreatedOn");
        p.AllowFilter("Status", "Price", "CreatedOn");
        p.AllowSearch("Name", "Description");
    });

MVC controller

public sealed class ProductsController : BaseApiPagedResultController
{
    private readonly AppDbContext _db;
    public ProductsController(AppDbContext db) => _db = db;

    [HttpGet]
    public async Task<IActionResult> List(
        [FromPagedQuery(typeof(Product))] PageRequestWithFilters request,
        CancellationToken ct)
    {
        if (!ModelState.IsValid) return ValidationProblem(ModelState);

        var paged = await _db.Products.AsNoTracking()
            .GetPagedWithFiltersAsync(request, cancellationToken: ct);

        return PagedOkResult(paged);
    }
}

Minimal API (.NET 7+)

app.MapGet("/products",
    async (PagedQueryWithFilters<Product> q, AppDbContext db, HttpContext ctx, CancellationToken ct) =>
    {
        if (!q.IsValid)
            return Results.ValidationProblem(
                q.Errors.ToDictionary(e => e.Key, e => new[] { e.Value }));

        var paged = await db.Products.AsNoTracking()
            .GetPagedWithFiltersAsync(q, cancellationToken: ct);

        return paged.ToPagedHttpResult(ctx);
    })
    .WithPagedResult();

Query-string syntax

GET /products
    ?page=2
    &pageSize=20
    &order=price:desc
    &search=usb
    &filter=status:Equals:active
    &filter=price:Between:10,100
    &fields=Id,Name,Price