MinimalApi.SlimEndpoints
1.3.3
dotnet add package MinimalApi.SlimEndpoints --version 1.3.3
NuGet\Install-Package MinimalApi.SlimEndpoints -Version 1.3.3
<PackageReference Include="MinimalApi.SlimEndpoints" Version="1.3.3" />
paket add MinimalApi.SlimEndpoints --version 1.3.3
#r "nuget: MinimalApi.SlimEndpoints, 1.3.3"
// Install MinimalApi.SlimEndpoints as a Cake Addin #addin nuget:?package=MinimalApi.SlimEndpoints&version=1.3.3 // Install MinimalApi.SlimEndpoints as a Cake Tool #tool nuget:?package=MinimalApi.SlimEndpoints&version=1.3.3
MinimalApi Slim Endpoints
Small library for decoupling endpoints in MinimalApi from the Program.cs file.
This library does not add any additional overhead to the application, it just helps you to organize your code better.
The source generator will generate a DependencyInjection extension that will contain all the endpoints that you have defined in your application.
Installation
Install the package from NuGet:
dotnet add package MinimalApi.SlimEndpoints
Quick start
Create a class that inherits from ISlimEndpoint
and implement the Configure
and Handler
methods. Add the SlimEndpoint
attribute to the class.
SlimEndpoint attribute
The SlimEndpoint
attribute has the following properties:
Path
- The path of the endpoint. This is the same as theMapGet
method in theMinimalApi
.HttpMethod
- The HTTP method of the endpoint. This is the same as theMapGet
method in theMinimalApi
.
Configure method
The Configure
method injects the RouteHandlerBuilder
into the endpoint class. Leave the method empty if you don't need to configure the endpoint.
Handler method
The Handler
method is the main method of the endpoint. It is called when the endpoint is hit.
Example
using MinimalApi.SlimEndpoints.Abstractions;
namespace SampleDemo.Endpoints;
[SlimEndpoint(Path = "/hello", Method = "GET")]
public partial class HelloEndpoint : ISlimEndpoint
{
public void Configure(RouteHandlerBuilder builder)
{
builder.AllowAnonymous();
}
public Delegate Handler => (() => "Hello World!");
}
Dependency Injection configuration
The MinimalApi.SlimEndpoints
library uses the Microsoft.Extensions.DependencyInjection
library for dependency injection. You can configure the DI container in the Program.cs
file.
var builder = WebApplication.CreateBuilder(args);
// Register endpoints
builder.Services.AddSlimEndpoints();
var app = builder.Build();
// Map endpoints
app.MapSlimEndpoints();
app.Run();
Common pitfalls
Please do not capture any services in the Handler
method that are injected into the endpoint class. Instead, inject the services into the Handler
method directly.
Injected services into the endpoint class should only be used in the Configure
method.
❌ BAD This example uses a service that is injected into the endpoint class.
[SlimEndpoint(Path = "/hello", Method = "GET")]
public partial class HelloEndpoint : ISlimEndpoint
{
private readonly ExampleService _service;
public HelloEndpoint(ExampleService service)
{
_service = service;
}
public void Configure(RouteHandlerBuilder builder)
{
builder.AllowAnonymous();
}
public Delegate Handler => (() => _service.GetExample());
}
✅ GOOD This example injects the service directly into the Handler
method.
[SlimEndpoint(Path = "/hello", Method = "GET")]
public partial class HelloEndpoint : ISlimEndpoint
{
public void Configure(RouteHandlerBuilder builder)
{
builder.AllowAnonymous();
}
public Delegate Handler => ((ExampleService service) => service.GetExample());
}
Note: Please see the SampleDemo project for a complete example.
Change log
Please see the CHANGELOG for more information on what has changed recently.
License
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. 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. |
-
net7.0
- MinimalApi.SlimEndpoints.Abstractions (>= 1.3.3)
- MinimalApi.SlimEndpoints.SourceGenerator (>= 1.3.3)
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.3.3 | 430 | 1/16/2023 |
1.3.2 | 305 | 1/14/2023 |
1.3.1 | 287 | 1/13/2023 |
1.2.1-release-g982b77e2d6 | 163 | 1/12/2023 |
1.1.1-g64231a551d | 157 | 1/12/2023 |
1.0.5-g83325a6b56 | 137 | 1/12/2023 |