Caravel.AspNetCore 0.32.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Caravel.AspNetCore --version 0.32.0                

                    
                

            
NuGet\Install-Package Caravel.AspNetCore -Version 0.32.0
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="Caravel.AspNetCore" Version="0.32.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Caravel.AspNetCore --version 0.32.0                

                    
                

            
#r "nuget: Caravel.AspNetCore, 0.32.0"
#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 Caravel.AspNetCore as a Cake Addin
#addin nuget:?package=Caravel.AspNetCore&version=0.32.0

// Install Caravel.AspNetCore as a Cake Tool
#tool nuget:?package=Caravel.AspNetCore&version=0.32.0

Caravel.AspNetCore

This package contains reusable middleware, http utilities that every application needs.

  • Exception Middleware
// Handle exceptions according to RFC: https://tools.ietf.org/html/rfc7807
builder.Services.AddExceptionHandler<GlobalExceptionHandler>();
builder.Services.AddProblemDetails();

// Map the middleware
_application.UseExceptionHandler();

{
  "code": "book_not_found",
  "title": "Book does not exist",
  "status": 404,
  "detail": "Book 53655b3d-48d5-4ac1-ba73-4318b3b702e8 does not exist",
}
  • ApiKey Endpoint Filter
services.Configure<ApiKeyOptions>(configuration.GetSection("Authentication"));

// Add to a group or single endpoints using: .AddEndpointFilter<ApiKeyEndpointFilter>();
var versionedGroup = application
    .MapGroup("api/v{version:apiVersion}")
    .WithApiVersionSet(apiVersionSet)
    .AddEndpointFilter<ApiKeyEndpointFilter>();

{
  "title": "Provide X-API-KEY header.",
  "status": 401,
  "code": "api_key_missing"
}
  • Endpoint Features

Add all endpoints features that implement IEndpointFeature interface.

builder.Services.AddEndpointFeatures(Assembly.GetExecutingAssembly());

Map feature endpoints.

ApiVersionSet apiVersionSet = app.NewApiVersionSet()
.HasApiVersion(new ApiVersion(1))
.ReportApiVersions()
.Build();

RouteGroupBuilder versionedGroup = app
.MapGroup("api/v{version:apiVersion}")
.WithApiVersionSet(apiVersionSet);

app.MapEndpointFeatures(versionedGroup);
  • User Context Implementation using HttpContextAccessor
// Requirement since it's injected in the UserContext implementation
services.AddHttpContextAccessor();
services.AddScoped<IUserContext, UserContext>();

// Inject IUserContext in your services

public MyService(IUserContext userContext) 
{
    var userId = userContext.UserId();
}
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.32.0 87 10/12/2024
0.31.0 78 10/12/2024
0.30.0 74 10/12/2024
0.29.0 98 10/2/2024
0.28.0 92 10/2/2024
0.27.0 102 9/29/2024
0.26.0 71 9/28/2024
0.25.0 74 9/28/2024
0.24.0 114 8/20/2024
0.23.0 229 12/10/2023
0.20.0 446 9/24/2022
0.19.0 128 9/24/2022
0.17.0 216 9/27/2021
0.16.0 360 4/10/2021
0.15.1 390 1/23/2021
0.15.0 368 11/21/2020
0.14.0 450 11/15/2020
0.13.0 419 10/27/2020
0.12.1 406 10/14/2020
0.12.0 445 10/14/2020
0.11.1 468 10/12/2020
0.11.0 443 10/12/2020
0.10.0 494 9/10/2020
0.9.1 428 9/5/2020
0.9.0 437 9/5/2020
0.8.0 575 5/29/2020
0.7.0 464 5/16/2020
0.5.0 482 4/11/2020
0.4.2 480 4/11/2020
0.4.1 502 4/10/2020
0.4.0 653 1/27/2020
0.3.2 776 1/11/2020
0.3.1 508 1/11/2020
0.3.0 492 1/11/2020
0.2.2 586 1/4/2020
0.2.1 535 12/26/2019
0.2.0 537 12/26/2019