Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/co-it/csharpfunctionalextensions.httpresults
Extensions for CSharpFunctionalExtensions to map Results to HttpResults in your MinimalApi
https://github.com/co-it/csharpfunctionalextensions.httpresults
actionresult api csharp csharpfunctionalextensions dotnet http minimal nuget
Last synced: about 17 hours ago
JSON representation
Extensions for CSharpFunctionalExtensions to map Results to HttpResults in your MinimalApi
- Host: GitHub
- URL: https://github.com/co-it/csharpfunctionalextensions.httpresults
- Owner: co-IT
- License: mit
- Created: 2024-06-13T15:29:56.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-29T15:37:02.000Z (27 days ago)
- Last Synced: 2024-09-20T06:02:08.442Z (5 days ago)
- Topics: actionresult, api, csharp, csharpfunctionalextensions, dotnet, http, minimal, nuget
- Language: C#
- Homepage: https://github.com/co-IT/CSharpFunctionalExtensions.HttpResults
- Size: 86.9 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CSharpFunctionalExtensions.HttpResults
[](https://www.nuget.org/packages/CSharpFunctionalExtensions.HttpResults/)
[](https://www.nuget.org/packages/CSharpFunctionalExtensions.HttpResults/)
[](https://www.nuget.org/packages/CSharpFunctionalExtensions.HttpResults/)
[](https://github.com/co-IT/CSharpFunctionalExtensions.HttpResults/blob/main/LICENSE.md)
Extensions for [CSharpFunctionalExtensions](https://github.com/vkhorikov/CSharpFunctionalExtensions) to map Results to
HttpResults in your MinimalApi
## Installation
Available on [NuGet](https://www.nuget.org/packages/CSharpFunctionalExtensions.HttpResults/).
```bash
dotnet add package CSharpFunctionalExtensions.HttpResults
```
or
```powershell
PM> Install-Package CSharpFunctionalExtensions.HttpResults
```
## Usage
This library provides you extension methods to map the following types to `HttpResults`:
- `Result`
- `Result`
- `Result`
- `UnitResult`
These methods are available:
| Method | Short Description |
|---------------------------------------|------------------------------------------------------------------------------|
| `.ToStatusCodeHttpResult()` | Returns `StatusCodeHttpResult` or `ProblemHttpResult` |
| `.ToStatusCodeHttpResult()` | Returns `StatusCodeHttpResult` or `ProblemHttpResult` |
| `.ToStatusCodeHttpResult()` | Returns `StatusCodeHttpResult` or custom error |
| `.ToStatusCodeHttpResult()` | Returns `StatusCodeHttpResult` or custom error |
| `.ToJsonHttpResult()` | Returns `JsonHttpResult` or `ProblemHttpResult` |
| `.ToJsonHttpResult()` | Returns `JsonHttpResult` or custom error |
| `.ToOkHttpResult()` | Returns `Ok` or `ProblemHttpResult` |
| `.ToOkHttpResult()` | Returns `Ok` or custom error |
| `.ToNoContentHttpResult()` | Returns `NoContent` or `ProblemHttpResult` |
| `.ToNoContentHttpResult()` | Discards value of `Result` and returns `NoContent` or `ProblemHttpResult` |
| `.ToNoContentHttpResult()` | Discards value of `Result` and returns `NoContent` or custom error |
| `.ToNoContentHttpResult()` | Returns `NoContent` or custom error |
| `.ToCreatedHttpResult()` | Returns `Created` or `ProblemHttpResult` |
| `.ToCreatedHttpResult()` | Returns `Created` or custom error |
| `.ToCreatedAtRouteHttpResult()` | Returns `CreatedAtRoute` or `ProblemHttpResult` |
| `.ToCreatedAtRouteHttpResult()` | Returns `CreatedAtRoute` or custom error |
| `.ToAcceptedHttpResult()` | Returns `Accepted` or `ProblemHttpResult` |
| `.ToAcceptedHttpResult()` | Returns `Accepted` or custom error |
| `.ToAcceptedAtRouteHttpResult()` | Returns `AcceptedAtRoute` or `ProblemHttpResult` |
| `.ToAcceptedAtRouteHttpResult()` | Returns `AcceptedAtRoute` or custom error |
| `.ToFileHttpResult()` | Returns `FileContentHttpResult` or `ProblemHttpResult` |
| `.ToFileHttpResult()` | Returns `FileContentHttpResult` or custom error |
| `.ToFileStreamHttpResult()` | Returns `FileStreamHttpResult` or `ProblemHttpResult` |
| `.ToFileStreamHttpResult()` | 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](https://www.rfc-editor.org/rfc/rfc9457).
The status property contains the status code.
The type property contains a URI to the corresponding [RFC9110](https://tools.ietf.org/html/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` or `UnitResult`.
1. First create a custom error type
```csharp
public class UserNotFoundError
{
public required string UserId { get; init; }
}
```
2. Create a mapper that implements `IResultErrorMapper` which maps this custom error type to an `IResult` that you want to return in your WebAPI:
```csharp
public class UserNotFoundErrorMapper : IResultErrorMapper
{
public Func 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:
```csharp
app.MapGet("/users/{id}", (string id) => {
return userRepository.Find(id) //Result
.ToOkHttpResult(); //returns 200 with User as payload or 404 with ProblemDetails object defined above
});
```
Make sure that every custom error type has exactly one corresponding `IResultMapper` implementation. Otherwise, the build might fail with diagnostic error [CFEHTTPR002](./CSharpFunctionalExtensions.HttpResults.Generators/AnalyzerReleases.Shipped.md).
If extension methods for custom errors are missing, rebuild the project to trigger Source Generation.
Optionally, there is a helper method `ProblemDetailsMap.Find()` to find a suitable title and type for a status code based on [RFC9110](https://tools.ietf.org/html/rfc9110).