Nestgrid.Response.Http 0.8.0

Nestgrid.Response.Http

Shared HTTP response mapping policy for Nestgrid.Response adapters.

Nestgrid.Response.Http maps result statuses to HTTP status codes and selects response payloads. It does not execute responses and does not depend on ASP.NET Core MVC packages.

Installation

dotnet add package Nestgrid.Response.Http

Most applications should install an adapter package instead:

dotnet add package Nestgrid.Response.AspNetCore

or:

dotnet add package Nestgrid.Response.Mvc

Quick Start

using Nestgrid.Response;
using Nestgrid.Response.Http.Mappings;
using Nestgrid.Response.Http.Options;

var options = new NestgridResponseOptions
{
    SuccessResponseMode = SuccessResponseMode.ValueOnly
};

HttpResultMapping mapping = HttpResultMapper.Map(
    Results.NotFound<UserDto>("User was not found."),
    options,
    hasValue: false,
    value: null);

Realistic Example

Use this package directly when you are building a custom adapter around the core result model:

using Nestgrid.Response;
using Nestgrid.Response.Http.Mappings;
using Nestgrid.Response.Http.Options;

public static CustomResponse ToCustomResponse<T>(
    Result<T> result,
    NestgridResponseOptions options)
{
    var mapping = HttpResultMapper.Map(
        result,
        options,
        hasValue: true,
        value: result.Value);

    return new CustomResponse(
        statusCode: mapping.StatusCode,
        body: mapping.Body);
}

Application developers usually use ToIResult() or ToActionResult() from an adapter package instead of calling HttpResultMapper directly.

Feature Summary

• Default mapping from every ResultStatus to an HTTP status code.
• Configurable status mappings through NestgridResponseOptions.
• FullResult and ValueOnly success payload modes.
• Consistent failure payload behavior.
• Bodyless handling for ResultStatus.NoContent.
• Shared policy used by ASP.NET Core and MVC adapters.

Default Status Mappings

If a mapping is removed from an options instance, the mapper falls back to the default mapping.

Custom mappings are an intentional consumer capability. Treat the default mappings for Unauthorized, Forbidden, Error and NoContent as normative unless there is a reviewed integration reason to change them. Remapping these outcomes can alter authentication, authorisation, caching and client-control semantics.

Payload Modes

FullResult writes the result envelope.

ValueOnly writes only the value for successful generic results.

Failures always write the result envelope. NoContent never writes a response body.

Documentation

• Main repository
• Architecture overview
• ASP.NET Core package
• MVC package

Samples

• ASP.NET Core sample
• MVC sample