Nextended.Web 10.1.34

Nextended.Web

ASP.NET Core utilities — zero-config OData (AddODataAuto), composable IQueryable OData appliers, strongly typed controller URLs, streaming download helpers and a background executor that can replay a captured request.

📖 Documentation: English · Deutsch

Installation

dotnet add package Nextended.Web

Feature map

Quick start

OData that builds its own EDM model

Annotate the entities you want exposed and skip the ODataConventionModelBuilder boilerplate:

using Nextended.Core.Attributes;

[ProvideAsEdm("Products")]
public class Product
{
    public Guid Id { get; set; }
    public string Name { get; set; } = "";
    public decimal Price { get; set; }
    public Category? Category { get; set; }
}

// Base types can hand the registration down to every derived type:
[ProvideAsEdm(ProvideInherits = true)]
public abstract class EntityBase { public Guid Id { get; set; } }

// Program.cs
builder.Services.AddODataAuto();                       // scans for [ProvideAsEdm]
builder.Services.AddControllers().AddODataAuto(
    ProvidedAsEdm.GetEdmModel(), routePrefix: "odata");

ProvidedAsEdm collects the annotated types, wires inheritance between them, creates entity sets for the annotated types and for navigation targets they reach, and caches the resulting model.

A controller you barely have to write

using Nextended.Web.Controller;

public class ProductsController(AppDbContext db) : GenericODataController<Product>
{
    protected override IQueryable<Product> Queryable() => db.Products;
}

You get GET /odata/Products with $filter, $orderby, $top, $skip, $expand, $search and facet building; and GET /odata/Products({key}). Override IdPropertyName when the key is not called Id, and GetFacetBuilderOptions() to shape the facets.

Applying OData options to any IQueryable

Useful when the endpoint is not an OData route but you still want the query semantics:

using Nextended.Web.Extensions;

[HttpGet]
public async Task<IActionResult> Search(ODataQueryOptions<Product> options)
{
    var query = db.Products
        .ApplyODataFilter(options.Filter)
        .ApplyODataSearch(options.Search)
        .ApplyODataOrderBy(options.OrderBy)
        .ApplyODataSkip(options.Skip)
        .ApplyODataTop(options.Top);

    return Ok(await query.ToListAsync());
}

ApplyODataExpandIncludes translates $expand into EF Core Include chains, so expansion does not turn into N+1 queries.

Strongly typed URLs

using Nextended.Web.Helper;

var helper = new RequestHelper(urlHelper);

var url = helper.UrlFor<ProductsController>(c => c.Details(product.Id));
// refactor the action, the URL follows — no magic strings

Streaming a download

[HttpGet("export")]
public Task Export(CancellationToken ct)
    => this.DownloadDataAsync(
        writeResponseDataAction: stream => _exporter.WriteCsvAsync(stream, ct),
        mimeType: "text/csv",
        fileName: "products.csv",
        inlineFile: false,
        httpStatusCode: 200);

Nothing is buffered — the callback writes straight to the response body.

Work that must outlive the response

public async Task<IActionResult> Import(IFormFile file, [FromServices] BackgroundExecutor executor)
{
    // Captures the current request itself, so the detached scope can still see
    // headers, user and route after the response has gone out.
    await executor.ExecuteDetachedWithCapturedRequestAsync(
        timeout: TimeSpan.FromMinutes(10),
        action: async (services, ct) =>
        {
            var importer = services.GetRequiredService<IImporter>();
            await importer.RunAsync(ct);
        });

    return Accepted();
}

Overloads take a list of IDisposable/IAsyncDisposable to release after the work, and ExecuteDetachedAsync(snapshot, timeout, action) accepts a snapshot you captured yourself with HttpContext.CaptureAsync(ct) — for instance one taken before an earlier await.

var snapshot = await HttpContext.CaptureAsync(ct);
await executor.ExecuteDetachedAsync(snapshot, TimeSpan.FromMinutes(5), DoWorkAsync);

The action runs in a new DI scope, so the request's DbContext being disposed cannot break it. Timeouts, exceptions and disposable cleanup are logged rather than thrown into the void, and optional onSetup / onTeardown callbacks bracket the work.

Looking for permission-aware response shaping instead? That is Nextended.ResponseFilters.

Supported frameworks

• net8.0
• net9.0
• net10.0

Dependencies

• Nextended.Core
• Nextended.EF
• Microsoft.AspNetCore.OData

The Nextended family

The other 17 packages in the suite:

Core libraries

• Nextended.Core — Foundation library — extension methods, custom types (Money, Date, BaseId, SuperType), class mapping, deep clone, encryption, hashing and the code-generation attributes.
• Nextended.Cache — Expression-based caching — automatic cache keys from method expressions, CacheProvider with condition-based invalidation, thread-safe AddOrGetExisting.

Data access

• Nextended.EF — Entity Framework Core extensions — graph loading (LoadGraphAsync, IncludeAll, MultiInclude), declarative include definitions, paging, dynamic sorting and bulk operations.

ASP.NET Core & web

• Nextended.Web — ASP.NET Core utilities — zero-config OData (AddODataAuto), composable IQueryable OData appliers, strongly typed controller URLs, streaming download helpers and a background executor that can replay a captured request. (this package)
• Nextended.ResponseFilters — Fluent, provider-agnostic pipeline that redacts, masks, rounds, truncates, hashes, prunes and restructures response DTOs before serialization — per request, per user, per permission.
• Nextended.ResponseFilters.AspNetCore — ASP.NET Core adapter for Nextended.ResponseFilters — registers the pipeline as a global IAsyncResultFilter and replays structural edits against the serialized JSON tree.

UI libraries

• Nextended.Blazor — Blazor helpers — IBrowserFile extensions (bytes, data URLs, downloads), a hierarchical model for browsing inside uploaded zip/tar/rar archives, MIME-type detection and component-parameter reflection.
• Nextended.UI — WPF and Windows desktop helpers — a global input-binding manager with hold/sequence matching, DirectInput and XInput gamepad readers, key-bind capture controls, converters, behaviours, markup extensions and runtime-defined PropertyGrid types.

Code generation & tooling

• Nextended.Imaging — Image processing — aspect-preserving resize, crop, colour replacement, brightness-based foreground picking, thumbnail generation, byte/data-URL conversion and MIME detection from magic bytes.
• Nextended.CodeGen — Roslyn source generator — DTOs and interfaces from your entities, strongly typed classes from JSON/XML, lookup tables from Excel, and documentation from source files.

.NET Aspire hosting

• Nextended.Aspire — Conditional AppHost builder extensions — WithReferenceIf / WaitForIf / WithExplicitStartIf, strongly typed environment variables from config objects, HTTPS dev-cert wiring, Docker guards, GitHub-source resources and npm app discovery.
• Nextended.Aspire.Hosting.Supabase — The complete Supabase stack — Postgres, Auth (GoTrue), REST, Realtime, Storage, Studio, Kong and Edge Functions — as one composable Aspire resource.
• Nextended.Aspire.Hosting.N8n — The n8n workflow-automation platform as an Aspire resource, with Postgres persistence, workflow import and a typed client for triggering workflows from .NET.
• Nextended.Aspire.Hosting.Grafana — Grafana, Prometheus, Loki, Tempo, Promtail, cAdvisor, postgres_exporter and the OpenTelemetry Collector as composable resources with auto-provisioned datasources.
• Nextended.Aspire.Hosting.WebDataStudio — WebDataStudio — a browser database studio for PostgreSQL, MySQL, SQL Server, SQLite, Oracle, DuckDB, ClickHouse, MongoDB and Redis — wired to the databases of your stack, with accounts and roles, an optional SQL assistant, and an MCP endpoint for AI agents.
• Nextended.Aspire.Hosting.AspireUI — AspireUI — the visual AppHost builder — as a resource inside your own Aspire stack, with an optional pre-seeded admin user and a starter stack built from your project paths.
• Nextended.Aspire.Hosting.LocalAI — Self-hosted, OpenAI-compatible multimodal AI — image generation, text-to-speech, speech-to-text and video — with gallery model management, GPU support and Open WebUI.
• Nextended.Aspire.Hosting.Php — Run PHP endpoints inside your Aspire stack — a docroot folder or a single router script served by PHP's built-in web server, with php.ini settings as fluent options.

Links

• 📦 NuGet package
• 📖 Documentation — English
• 📖 Dokumentation — Deutsch
• 🏠 Documentation portal
• 🧑‍💻 Source code
• 🐛 Report an issue

License

GPL-3.0-or-later — see LICENSE.