CSharpFunctionalExtensions.HttpResults 0.0.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package CSharpFunctionalExtensions.HttpResults --version 0.0.2                
NuGet\Install-Package CSharpFunctionalExtensions.HttpResults -Version 0.0.2                
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="CSharpFunctionalExtensions.HttpResults" Version="0.0.2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add CSharpFunctionalExtensions.HttpResults --version 0.0.2                
#r "nuget: CSharpFunctionalExtensions.HttpResults, 0.0.2"                
#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.
// Install CSharpFunctionalExtensions.HttpResults as a Cake Addin
#addin nuget:?package=CSharpFunctionalExtensions.HttpResults&version=0.0.2

// Install CSharpFunctionalExtensions.HttpResults as a Cake Tool
#tool nuget:?package=CSharpFunctionalExtensions.HttpResults&version=0.0.2                

CSharpFunctionalExtensions.HttpResults

dotnet nuget version nuget downloads GitHub license

Extensions for CSharpFunctionalExtensions to map Results to HttpResults in your MinimalApi

Installation

Available on NuGet.

dotnet add package CSharpFunctionalExtensions.HttpResults

or

PM> Install-Package CSharpFunctionalExtensions.HttpResults

Usage

This library provides you extension methods to map the following types to HttpResults:

  • Result
  • Result<T>
  • Result<T,E>
  • UnitResult<E>

These methods are available:

Method Short Description
.ToHttpResult() Returns StatusCodeHttpResult or ProblemHttpResult
.ToHttpResult<T>() Returns JsonHttpResult<T> or ProblemHttpResult
.ToHttpResult<T,E>() Returns JsonHttpResult<T> or custom error
.ToNoContentHttpResult<T>() Discards value of Result<T> and returns empty StatusCodeHttpResult or ProblemHttpResult
.ToNoContentHttpResult<T,E>() Discards value of Result<T> and returns empty StatusCodeHttpResult or custom error
.ToCreatedHttpResult<T>() Returns Created<T> or ProblemHttpResult
.ToCreatedHttpResult<T,E>() Returns Created<T> or custom error
.ToCreatedAtRouteHttpResult<T>() Returns CreatedAtRoute<T> or ProblemHttpResult
.ToCreatedAtRouteHttpResult<T,E>() Returns CreatedAtRoute<T> or custom error
.ToAcceptedHttpResult<T>() Returns Accepted<T> or ProblemHttpResult
.ToAcceptedHttpResult<T,E>() Returns Accepted<T> or custom error
.ToAcceptedAtRouteHttpResult<T>() Returns AcceptedAtRoute<T> or ProblemHttpResult
.ToAcceptedAtRouteHttpResult<T,E>() Returns AcceptedAtRoute<T> or custom error
.ToFileHttpResult<byte[]>() Returns FileContentHttpResult or ProblemHttpResult
.ToFileHttpResult<byte[],E>() Returns FileContentHttpResult or custom error
.ToFileHttpResult<Stream>() Returns FileStreamHttpResult or ProblemHttpResult
.ToFileHttpResult<Stream,E>() Returns FileStreamHttpResult or custom error
.ToFileStreamHttpResult<Stream>() Returns FileStreamHttpResult or ProblemHttpResult
.ToFileStreamHttpResult<Stream,E>() Returns FileStreamHttpResult or custom error

For almost every method you can override the default status codes for Success/Failure.

All methods are available in sync and async variants.

By default, failures get mapped to a ProblemHttpResult based on RFC9457. The status property contains the status code. The type property contains a URI to the corresponding RFC9110 entry based on the status code. The title property contains a generic short messages based on the status code. The detail property contains the error property of the Result.

If you want your own mapping logic read on.

Custom errors

This library uses a Source Generator to generate extension methods for your own custom error types when using Result<T,E> or UnitResult<E>.

  1. First create a custom error type that implements IResultError
    public class UserNotFoundError : IResultError
    {
        public required string UserId { get; init; }
    }
    
  2. Create a mapper that implements IResultErrorMapper which maps this custom error type to another type that you want to return in your web api:
    public class UserNotFoundErrorMapper : IResultErrorMapper<UserNotFoundError, Microsoft.AspNetCore.Http.IResult>
    {
        public Func<UserNotFoundErrorMapper, Microsoft.AspNetCore.Http.IResult> Map => error => {
            var problemDetails = new ProblemDetails
            {
                Status = 404,
                Title = "User not found",
                Type = "https://tools.ietf.org/html/rfc9110#section-15.5.5",
                Detail = $"The user with ID {error.UserId} couldn't be found.
            };
    
            return TypedResults.Problem(problemDetails);  
        };
    }
    
  3. Use the generated extension method:
    app.MapGet("/users/{id}", (string id) => {
        return userRepository.find(id) //Result<User,UserNotFoundError>
            .ToHttpResult();
    });
    

Make sure that every IResult implementation only has exactly one corresponding IResultMapper implementation.

Optionally, you can use the ProblemDetailsMap.Find() method to find a title and type for a status code based on RFC9110.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.2.0 714 7/18/2024
0.1.0 79 7/18/2024
0.0.5 87 7/12/2024
0.0.4 81 7/12/2024
0.0.3 77 7/12/2024
0.0.2 92 6/17/2024
0.0.1 81 6/14/2024