Knight.Response.Abstractions.Http 2.0.0-preview01

Knight.Response.Abstractions.Http

Cross‑framework abstractions for HTTP result handling in the Knight.Response family.

This package collects the shared contracts and options that both

• Knight.Response.AspNetCore (for modern ASP.NET Core / minimal APIs), and
• Knight.Response.AspNetCore.Mvc (for legacy ASP.NET Core MVC 2.x / .NET Framework scenarios)

use to keep behavior consistent.

Target frameworks: .NET Standard 2.0 (works with .NET Framework 4.7.1+ and .NET Core/.NET 6+).

What’s inside

• KnightResponseBaseOptions<TH, TProblem, TValidation> Base options class that centralizes:

  • UseProblemDetails (default: false)
  • UseValidationProblemDetails (default: false)
  • IncludeFullResultPayload (default: false, was true before 2.0.0-preview01)
  • IncludeExceptionDetails (default: false)
  • StatusCodeResolver delegate
  • Optional builders/hooks for shaping problem responses

  The generic parameters let each integration plug in the framework’s own HttpContext type (TH), ProblemDetails type (TProblem), and ValidationProblemDetails type (TValidation) without duplication.

• Validation error mapping

  • IValidationErrorMapper — abstraction for converting domain Messages into a Dictionary<string,string[]> suitable for validation problems.
  • Consumers are expected to register their own mapper in DI. If none is provided, integrations will fall back to the built‑in DefaultValidationErrorMapper at runtime.

Install

dotnet add package Knight.Response.Abstractions.Http

You typically won’t reference this directly in application code; it’s a transitive dependency of the ASP.NET/MVC integration packages. It’s useful if you’re building your own integration and want to align with Knight.Response conventions.

Quick example (custom mapper)

using Knight.Response.Abstractions.Http.Mappers;

public sealed class MyValidationMapper : IValidationErrorMapper
{
    public IDictionary<string, string[]> Map(IReadOnlyList<Message> messages)
        => new Dictionary<string, string[]> { ["name"] = new[] { "is required" } };
}

Register this type in the DI container of your chosen integration package (e.g., Knight.Response.AspNetCore or Knight.Response.Mvc).

Related packages

• Knight.Response — immutable Result / Result<T> core library.
• Knight.Response.AspNetCore — modern ASP.NET Core + minimal APIs integration.
• Knight.Response.AspNetCore.Mvc — ASP.NET Core MVC 2.x / .NET Framework–friendly integration.

License

This project is licensed under the MIT License.

Contributing

Contributions are welcome! Please read CONTRIBUTING.md.