Reprise 1.1.0

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

// Install Reprise as a Cake Tool
#tool nuget:?package=Reprise&version=1.1.0

Reprise

Reprise is a micro-framework that brings the REPR (Request-Endpoint-Response) pattern and vertical slice architecture into ASP.NET Core 6 Minimal APIs. It aims to be unopioniated towards the API behavior and to provide a thin layer of abstractions that encourages the creation of convention-based and modular codebases.

Getting Started

  1. Create a new ASP.NET Core 6 empty project.

  2. Install the Reprise NuGet package.

  3. Modify your Program.cs to use Reprise.

var builder = WebApplication.CreateBuilder();
builder.ConfigureServices();
var app = builder.Build();
app.MapEndpoints();
app.Run();
  1. Create an endpoint Endpoints/GetHelloEndpoint.cs.
[Endpoint]
public class GetHelloEndpoint
{
    [Get("/")]
    public static string Handle() => "Hello, world!";
}
  1. Run the application.

Endpoints

An endpoint is a public class that is decorated with the EndpointAttribute. It should contain a public static Handle method which should be decorated with one of the HTTP method and route attributes. These are:

  • GetAttribute
  • PostAttribute
  • PutAttribute
  • PatchAttribute
  • DeleteAttribute
  • MapAttribute - for other/multiple HTTP methods

The Handle method can be synchronous as well as asynchronous and can have any signature and any return type.

[Endpoint]
public class UpdateUserEndpoint
{
    [Authorize]
    [Put("/users/{id}")]
    public static IResult Handle(int id, UserDto userDto, DataContext context)
    {
        // ...
    }
}

In the example id comes from the route, userDto - from the body, and context - from the DI container. Check the Minimal APIs documentation for more information on the topic.

On application startup, app.MapEndpoints() and app.MapEndpoints(assembly) perform an assembly scan and map all endpoints. Reprise will throw an InvalidOperationExcaption when:

  • An endpoint has no Handle method
  • An endpoint has multiple Handle methods
  • A Handle method has no HTTP method and route attribute
  • A Handle method has multiple HTTP method and route attributes
  • A Handle method has an empty route
  • A Handle method has an empty HTTP method
  • An HTTP method and route combination is handled by more than one endpoint

Services

Any class (including an endpoint) that has a public parameterless constructor and implements IServiceConfgurator can configure services.

[Endpoint]
public class GetWeather : IServiceConfigurator
{
    public void ConfigureServices(WebApplicationBuilder builder)
    {
        builder.Services.AddWeatherService();
    }

    [Get("/weather")]
    public static async Task<WeatherForecast[]> Handle(IWeatherService weatherService)
    {
        return await weatherService.GetForecast();
    }
}

On application startup, builder.ConfigureServices() and builder.ConfigureServices(assembly) perform an assembly scan and invoke all ConfigureServices(WebApplicationBuilder builder) implementations. Reprise will throw an InvalidOperationException if a service configurator has no public paramereterless constructor.

Configuration

Reprise makes it possible to bind a strongly typed hierarchical configuration. A simple example would look like this:

[Endpoint]
public class GetGreetings
{
    [Get("/greetings")]
    public static IEnumerable<string> Handle(GreetingConfiguration configuration)
    {
        return configuration.Names.Select(name => string.Format(configuration.Message, name));
    }
}

[Configuration("Greeting")]
public class GreetingConfiguration
{
    public string Message { get; set; } = null!;

    public List<string> Names { get; set; } = null!;
}

The GreetingConfiguration is added to the DI container with a singleton lifetime and is bound to the following section in appsettings.json:

{
    "Greeting": {
        "Message": "Hello, {0}!",
        "Names": [ "Alice", "John", "Skylar" ]
    }
}

Deeper nested sub-sections could as well be bound using a key like "Foo:Bar".

On application startup, builder.ConfigureServices() and builder.ConfigureServices(assembly) perform an assembly scan and add all configurations with a singleton lifetime. Reprise will throw an InvalidOperationException if a configuration model could not be bound or when a sub-section is bound to multiple types.

OpenAPI

In order to group endpoints in the Swagger UI, Reprise extracts a tag from the route of every endpoint. The first segment that is not "api" (case insensitive) or a parameter is capitalized and set as a tag. "/" is used when no match is found.

Performance

Besides the assembly scans at application startup when configuring the DI container and mapping endpoints, Reprise doesn't add any performance overhead when handling requests.

Support

If you spot any problems and/or have improvement ideas, please share them via the issue tracker.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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.
  • net6.0

    • No dependencies.

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
3.7.0 206 7/16/2023
3.6.0 142 7/12/2023
3.5.0 236 4/30/2023
3.4.2 336 2/20/2023
3.4.1 236 2/16/2023
3.4.0 271 2/5/2023
3.3.1 225 2/3/2023
3.3.0 259 2/1/2023
3.2.0 286 1/20/2023
3.1.6 312 12/20/2022
3.1.5 286 12/18/2022
3.1.4 275 12/12/2022
3.1.3 275 12/11/2022
3.1.2 325 12/4/2022
3.1.1 319 11/30/2022
3.1.0 306 11/27/2022
3.0.0 301 11/26/2022
2.2.0 320 11/23/2022
2.1.0 340 11/21/2022
2.0.0 317 11/19/2022
1.1.0 344 10/30/2022
1.0.3 378 10/22/2022
1.0.2 378 10/21/2022
1.0.1 393 10/20/2022
1.0.0 944 10/19/2022