Split out the Futurum.Core integration.

Author: futurum-dev

.idea/.idea.Futurum.WebApiEndpoint.Micro/.idea/aws.xml

@@ -32,13 +32,9 @@ public class GreetingWebApiEndpoint : IWebApiEndpoint
 - [x] Full support and built on top of [minimal apis](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/minimal-apis?view=aspnetcore-7.0)
 - [x] Full support for OpenApi
 - [x] Full support for [TypedResults](https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.http.typedresults?view=aspnetcore-7.0)
-- [x] [Full compatibility](#full-compatibility-with-futurumcore) with [Futurum.Core](https://www.nuget.org/packages/Futurum.Core)
 - [x] [Supports uploading file(s) with additional JSON payload](#uploading-files-with-additional-json-payload)
 - [x] Api Versioning baked-in
 - [x] Built in [sandbox runner](#sandbox-runner) with full [TypedResults support](https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.http.typedresults?view=aspnetcore-7.0), catching unhandled exceptions and returning a [ProblemDetails](https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.mvc.problemdetails?view=aspnetcore-7.0) response
-- [x] [Built in Validation support](#validation)
-  - [x] [Integrated FluentValidation](#fluentvalidationservice)
-  - [x] [Integrated DataAnnotations](#dataannotationsvalidationservice)
 - [x] Autodiscovery of WebApiEndpoint(s), based on Source Generators
 - [x] [Roslyn Analysers](#roslyn-analysers) to help build your WebApiEndpoint(s), using best practices
 - [x] Built on dotnet 7
@@ -345,64 +341,6 @@ global using static Futurum.WebApiEndpoint.Micro.WebApiEndpointRunner;
 
 This means you can use the helper functions without having to specify the namespace. As in the examples.
 
-## Validation
-### ValidationService
-Executes FluentValidation and DataAnnotations
-```csharp
-IValidationService<ArticleDto> validationService
-```
-
-e.g.
-```csharp
-private static Results<Ok<ArticleDto>, ValidationProblem, BadRequest<ProblemDetails>> ValidationHandler(HttpContext context, IValidationService<ArticleDto> validationService,
-                                                                                                        ArticleDto articleDto) =>
-    validationService.Execute(articleDto)
-                     .Map(() => new Article(null, articleDto.Url))
-                     .Map(ArticleMapper.MapToDto)
-                     .ToWebApi(context, ToOk, ToValidationProblem);
-```
-
-### FluentValidationService
-Calls FluentValidation
-```csharp
-IFluentValidationService<ArticleDto> fluentValidationService
-```
-
-e.g.
-```csharp
-private static Results<Ok<ArticleDto>, ValidationProblem, BadRequest<ProblemDetails>> FluentValidationHandler(HttpContext context, IFluentValidationService<ArticleDto> fluentValidationService,
-                                                                                                              ArticleDto articleDto) =>
-    fluentValidationService.Execute(articleDto)
-                           .Map(() => new Article(null, articleDto.Url))
-                           .Map(ArticleMapper.MapToDto)
-                           .ToWebApi(context, ToOk, ToValidationProblem);
-
-public class ArticleDtoValidator : AbstractValidator<ArticleDto>
-{
-    public ArticleDtoValidator()
-    {
-        RuleFor(x => x.Url).NotEmpty().WithMessage("must have a value;");
-    }
-}
-```
-
-### DataAnnotationsValidationService
-Calls DataAnnotations validation
-```csharp
-IDataAnnotationsValidationService dataAnnotationsValidationService
-```
-
-e.g.
-```csharp
-private static Results<Ok<ArticleDto>, ValidationProblem, BadRequest<ProblemDetails>> DataAnnotationsValidationHandler(HttpContext context,
-                                                                                                                       IDataAnnotationsValidationService dataAnnotationsValidationService,
-                                                                                                                       ArticleDto articleDto) =>
-    dataAnnotationsValidationService.Execute(articleDto)
-                                    .Map(() => new Article(null, articleDto.Url))
-                                    .Map(ArticleMapper.MapToDto)
-                                    .ToWebApi(context, ToOk, ToValidationProblem);
-```
-
 ## Uploading file(s) with additional JSON payload
 ### Upload single file and payload
 Use the *FormFileWithPayload* type to upload a single file and a JSON payload
@@ -452,68 +390,6 @@ Use the *FormFilesWithPayload* type to upload multiple files and a JSON payload
     }
 ```
 
-## Full compatibility with [Futurum.Core](https://www.nuget.org/packages/Futurum.Core)
-Comprehensive set of extension methods to transform a [Result](https://docs.futurum.dev/dotnet.futurum.core/result/overview.html) and [Result&lt;T&gt;](https://docs.futurum.dev/dotnet.futurum.core/result/overview.html) to an *TypedResult*.
-
-- If the method passed in is a *success*, then the *IResult* will be returned.
-- If the method passed in is a *failure*, then a *BadRequest&lt;ProblemDetails&gt;* will be returned, with the appropriate details set on the ProblemDetails. The *error message* will be safe to return to the client, that is, it will not contain any sensitive information e.g. StackTrace.
-
-The returned type from *ToWebApi* is always augmented to additionally include *BadRequest&lt;ProblemDetails&gt;*
-
-```csharp
-Result<T> -> Results<T, BadRequest<ProblemDetails>>
-
-Result<Results<TIResult1, TIResult2>> -> Results<TIResult1, TIResult2, BadRequest<ProblemDetails>>
-
-Result<Results<TIResult1, TIResult2, TIResult3>> -> Results<TIResult1, TIResult2, TIResult3, BadRequest<ProblemDetails>>
-
-Result<Results<TIResult1, TIResult2, TIResult3, TIResult4>> -> Results<TIResult1, TIResult2, TIResult3, TIResult4, BadRequest<ProblemDetails>>
-
-Result<Results<TIResult1, TIResult2, TIResult3, TIResult4, TIResult5>> -> Results<TIResult1, TIResult2, TIResult3, TIResult5, BadRequest<ProblemDetails>>
-```
-
-*Results* has a maximum of 6 types. So 5 are allowed leaving one space left for the *BadRequest&lt;ProblemDetails&gt;*.
-
-#### How to handle *successful* and *failure* cases in a typed way with *TypedResult*
-You can optionally specify which TypedResult success cases you want to handle. This is useful if you want to handle a specific successes case differently.
-
-You can specify which TypedResult error cases you want to handle. This is useful if you want to handle a specific error case differently.
-
-If you have a *success* case, you must pass in the the *success* helper function first, then the *failure* helper functions.
-
-There can only be 1 *success* helper function, but there can be multiple *failure* helper functions.
-
-##### Example use
-The *ToWebApi* extension method will change the method return type to add *BadRequest&lt;ProblemDetails&gt;*, with the appropriate details set on the ProblemDetails. The *error message* will be safe to return to the client, that is, it will not contain any sensitive information e.g. StackTrace.
-
-You can then pass in additional helper functions to deal with successes and failures and these will change the return type to the appropriate *TypedResult*'s.
-
-*ToOk* is a function that will convert a *T* to an *Ok&lt;T&gt;*.
-
-*ToValidationProblem* is a function that will convert a *ValidationResultError* to a *ValidationProblem*.
-
-#### Full Example
-```csharp
-private static Results<Ok<ArticleDto>, ValidationProblem, BadRequest<ProblemDetails>> ValidationHandler(HttpContext context, IValidationService<ArticleDto> validationService,
-                                                                                                        ArticleDto articleDto) =>
-    validationService.Execute(articleDto)
-                     .Map(() => new Article(null, articleDto.Url))
-                     .Map(ArticleMapper.MapToDto)
-                     .ToWebApi(context, ToOk, ToValidationProblem);
-```
-
-## Success and Failure helper functions
-If you have a *success* case, you must pass in the the *success* helper function first, then the *failure* helper functions.
-
-There can only be 1 *success* helper function, but there can be multiple *failure* helper functions.
-
-**Note:** It is recommended to add the following to your *GlobalUsings.cs* file.
-```csharp
-global using static Futurum.WebApiEndpoint.Micro.WebApiResultsExtensions;
-```
-
-This means you can use the helper functions without having to specify the namespace. As in the examples.
-
 ### Success helper functions
 #### ToOk
 Converts a *T* to an *Ok&lt;T&gt;*.
@@ -562,21 +438,6 @@ This can be overridden by passing in a *string*.
 ToAccepted<T>("/api/articles")
 ```
 
-### Failure helper functions
-#### ToNotFound
-If a *ResultErrorKeyNotFound* has occured then it will convert it to a *NotFound&lt;ProblemDetails&gt;*, with the correct information set on the *ProblemDetails*.
-
-```csharp
-ToNotFound
-```
-
-#### ToValidationProblem
-If a *ResultErrorValidation* has occured then it will convert it to a *ValidationProblem*, with the correct information set on the *HttpValidationProblemDetails*.
-
-```csharp
-ToValidationProblem
-```
-
 ## Comprehensive samples
 There are examples showing the following:
 - [x] A basic blog CRUD implementation
@@ -585,15 +446,13 @@ There are examples showing the following:
 - [x] Bytes file download
 - [x] EndpointFilter on a specific WebApiEndpoint
 - [x] Exception handling
-- [x] [Result](https://docs.futurum.dev/dotnet.futurum.core/result/overview.html) error handling
 - [x] File(s) upload
 - [x] File(s) upload with Payload
 - [x] File download
 - [x] OpenApi versioning
 - [x] Output Caching
 - [x] Rate Limiting
 - [x] Security with a basic JWT example on a specific WebApiEndpoint
-- [x] Validation - DataAnnotations and FluentValidation and both combined
 - [x] Weather Forecast
 - [x] Addition project containing WebApiEndpoints
 
@@ -658,4 +517,4 @@ This uses the following attributes:
 
 ## Roslyn Analysers
 - FWAEM0001 - Non empty constructor found on WebApiEndpoint
-- FWAEM0002 - BadRequest without 'ProblemDetails' use found on WebApiEndpoint
+- FWAEM0002 - BadRequest without 'ProblemDetails' use found on WebApiEndpoint

README.md

@@ -16,4 +16,4 @@ private static Ok<DataCollectionDto<AdditionDto>> GetHandler(HttpContext context
                   .Select(AdditionMapper.Map)
                   .ToDataCollectionDto()
                   .ToOk();
-}
+}

docs/Futurum.WebApiEndpoint.Micro.Sample-openapi.png

@@ -2,28 +2,38 @@ namespace Futurum.WebApiEndpoint.Micro.Sample.Blog;
 
 public interface IBlogStorageBroker
 {
-    Task<Result<IEnumerable<Blog>>> GetAsync();
-    Task<Result<Blog>> GetByIdAsync(Id id);
+    Task<IEnumerable<Blog>> GetAsync();
+    Task<Blog> GetByIdAsync(Id id);
 
-    Task<Result<Blog>> AddAsync(Blog blog);
+    Task<Blog> AddAsync(Blog blog);
 
-    Task<Result<Blog>> UpdateAsync(Blog blog);
+    Task<Blog> UpdateAsync(Blog blog);
 
-    Task<Result> DeleteAsync(Id id);
+    Task DeleteAsync(Id id);
 }
 
 public class BlogStorageBroker : IBlogStorageBroker
 {
     private readonly List<Blog> _items = new();
 
-    public async Task<Result<IEnumerable<Blog>>> GetAsync() =>
-        _items.AsReadOnly().AsEnumerable().ToResultOk();
+    public async Task<IEnumerable<Blog>> GetAsync() =>
+        _items.AsReadOnly().AsEnumerable();
 
-    public async Task<Result<Blog>> GetByIdAsync(Id id) =>
-        _items.TrySingle(x => x.Id == id)
-              .ToResultErrorKeyNotFound(id.ToString(), typeof(Blog).FullName);
+    public async Task<Blog> GetByIdAsync(Id id)
+    {
+        try
+        {
+            var existingBlog = _items.Single(x => x.Id == id);
 
-    public async Task<Result<Blog>> AddAsync(Blog blog)
+            return existingBlog;
+        }
+        catch (Exception exception)
+        {
+            throw new KeyNotFoundException($"Unable to find {nameof(Blog)} with Id : '{id}'", exception);
+        }
+    }
+
+    public async Task<Blog> AddAsync(Blog blog)
     {
         var newBlog = blog with
         {
@@ -32,26 +42,37 @@ public async Task<Result<Blog>> AddAsync(Blog blog)
 
         _items.Add(newBlog);
 
-        return Result.Ok(newBlog);
+        return newBlog;
     }
 
-    public async Task<Result<Blog>> UpdateAsync(Blog blog)
+    public async Task<Blog> UpdateAsync(Blog blog)
     {
-        return _items.TrySingle(x => x.Id == blog.Id)
-                     .ToResultErrorKeyNotFound(blog.Id.ToString(), typeof(Blog).FullName)
-                     .Then(existingBlog =>
-                     {
-                         _items.Remove(existingBlog);
-                         _items.Add(blog);
-
-                         return blog.ToResultOk();
-                     });
+        try
+        {
+            var existingBlog = _items.Single(x => x.Id == blog.Id);
+
+            _items.Remove(existingBlog);
+            _items.Add(blog);
+
+            return blog;
+        }
+        catch (Exception exception)
+        {
+            throw new KeyNotFoundException($"Unable to find {nameof(Blog)} with Id : '{blog.Id}'", exception);
+        }
     }
 
-    public async Task<Result> DeleteAsync(Id id)
+    public async Task DeleteAsync(Id id)
     {
-        return _items.TrySingle(x => x.Id == id)
-                     .ToResult(() => $"Unable to find {nameof(Blog)} with Id : '{id}'")
-                     .Do(x => _items.Remove(x));
+        try
+        {
+            var existingBlog = _items.Single(x => x.Id == id);
+
+            _items.Remove(existingBlog);
+        }
+        catch (Exception exception)
+        {
+            throw new KeyNotFoundException($"Unable to find {nameof(Blog)} with Id : '{id}'", exception);
+        }
     }
-}
+}