Headless.Api.Mvc 0.4.15

.NET 10.0

dotnet add package Headless.Api.Mvc --version 0.4.15

NuGet\Install-Package Headless.Api.Mvc -Version 0.4.15

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Headless.Api.Mvc" Version="0.4.15" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Headless.Api.Mvc" Version="0.4.15" />
                    

                            Directory.Packages.props

<PackageReference Include="Headless.Api.Mvc" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Headless.Api.Mvc --version 0.4.15

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Headless.Api.Mvc, 0.4.15"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Headless.Api.Mvc@0.4.15

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Headless.Api.Mvc&version=0.4.15
                    

                            Install as a Cake Addin

#tool nuget:?package=Headless.Api.Mvc&version=0.4.15
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Headless.Api.Mvc

Framework integration for ASP.NET Core MVC/Web API with controllers, filters, JSON configuration, and common utilities.

Problem Solved

Provides consistent MVC configuration, base controllers, and URL canonicalization for traditional controller-based APIs. Exception-to-ProblemDetails mapping is handled globally by Headless.Api's HeadlessApiExceptionHandler (registered via AddHeadlessProblemDetails()), so MVC actions get the same response shape as Minimal-API endpoints.

Key Features

ApiControllerBase - Base controller with common utilities
Environment-based action filters (BlockInEnvironmentAttribute, RequireEnvironmentAttribute)
URL canonicalization middleware (RedirectToCanonicalUrlRule)
Pre-configured JSON and MVC options
API versioning integration with API Explorer

Installation

dotnet add package Headless.Api.Mvc

Quick Start

var builder = WebApplication.CreateBuilder(args);

builder.AddHeadless().ConfigureMvc();
builder.Services.AddControllers();

var app = builder.Build();

app.MapControllers();
app.Run();

Controller Example

[ApiController]
[Route("api/[controller]")]
public sealed class OrdersController : ApiControllerBase
{
    [HttpGet("{id:int}")]
    public async Task<IActionResult> GetAsync(int id, CancellationToken ct)
    {
        var order = await _service.GetAsync(id, ct).ConfigureAwait(false);
        return order is null ? NotFound() : Ok(order);
    }
}

Configuration

No additional configuration beyond what AddHeadless() requires. Configure Headless:StringEncryption and Headless:StringHash.

Dependencies

Headless.Api.Core
Asp.Versioning.Mvc
Asp.Versioning.Mvc.ApiExplorer
Microsoft.EntityFrameworkCore

Side Effects

Configures MvcOptions and JsonOptions for controllers

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.