AspNet.KickStarter 1.2.2

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package AspNet.KickStarter --version 1.2.2                

                    
                

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

                    
                

            
#r "nuget: AspNet.KickStarter, 1.2.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 AspNet.KickStarter as a Cake Addin
#addin nuget:?package=AspNet.KickStarter&version=1.2.2

// Install AspNet.KickStarter as a Cake Tool
#tool nuget:?package=AspNet.KickStarter&version=1.2.2

AspNet.KickStarter

This library provides small helpers to reduce the repetitive code used to run AspNet Minimal API projects.

The AspNet.KickStarter package can be used as a single reference to pull in all of the individual packages in the collection.

To reduce the dependencies the individual packages may be referenced instead.

  • AspNet.KickStarter.Core This is the base library that provides the ApiBuilder.
  • AspNet.KickStarter.AddIn.xxx These are the packages that provide the extended functionality such as OpenTelemetry and FluentValidation.
  • AspNet.KickStarter.CQRS This provides a number of interfaces and classes to use when working with MediatR. Including functional result types and automatic trace activities of handlers.

ApiBuilder

This simplifies the bootstrapping code to run a minimal API with optional support for Serilog, FluentValidation, Prometheus metrics and Swagger.

The most basic use in a Program.cs file would be

await new ApiBuilder().Build(args).RunAsync();

For something more visible, add Swagger and some endpoints:

await new ApiBuilder().WithSwagger().WithHealthHandler().Build(args).RunAsync();

Many fluent extension methods are available through the AddIn packages to add extra functionality. Each extension may provide additional configuration parameters.

Further information about the extensions may be found in the readme for the AddIn package. See NuGet for the full list of AddIns.

await new ApiBuilder()
    .WithSerilog()
    .WithSwagger()
    .WithHealthHandler()
    .WithServices(builder => {...})
    .WithEndpoints(app => {...})
    .WithMappings(() => {...})
    .WithOpenTelemetry()
    .WithFluentValidationFromAssemblyContaining<T>()
    .WithAdditionalConfiguration(builder => {...})
    .Build(args)
    .RunAsync();

IEndpointRouteBuilder Extensions

These extensions consolidate the AspNet extensions

app.MapXXX(route, handler)
   .WithName(name)
   .WithDescription(description)
   .WithOpenApi()

into a single extension with parameters for the name and description.

MapXXX(route, name, description, handler)
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
1.2.3 109 6/18/2024
1.2.2 237 6/3/2024
1.2.1 68 6/3/2024
1.2.0 66 6/3/2024
1.1.0 332 12/4/2023
1.0.7 593 10/22/2023
1.0.6 152 10/21/2023
1.0.5 379 10/9/2023
1.0.4 119 10/6/2023
1.0.3 142 10/4/2023
1.0.2 120 10/3/2023
1.0.1 114 10/1/2023
1.0.0 120 9/30/2023