https://github.com/vlada22/minimal-api-slim-endpoints
MinimalApi SlimEndpoints
https://github.com/vlada22/minimal-api-slim-endpoints
dotnet endpoints minimalapi slim-endpoints source-generators
Last synced: 8 months ago
JSON representation
MinimalApi SlimEndpoints
- Host: GitHub
- URL: https://github.com/vlada22/minimal-api-slim-endpoints
- Owner: vlada22
- License: mit
- Created: 2023-01-12T16:41:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-16T09:10:22.000Z (over 3 years ago)
- Last Synced: 2024-12-01T17:55:57.201Z (over 1 year ago)
- Topics: dotnet, endpoints, minimalapi, slim-endpoints, source-generators
- Language: C#
- Homepage:
- Size: 30.3 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# MinimalApi Slim Endpoints
[](https://www.nuget.org/packages/MinimalApi.SlimEndpoints)
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:
```bash
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 the `MapGet` method in the `MinimalApi`.
- `HttpMethod` - The HTTP method of the endpoint. This is the same as the `MapGet` method in the `MinimalApi`.
### 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
```csharp
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.
```csharp
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.
```csharp
[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.
```csharp
[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](./samples/SampleDemo) project for a complete example.
## Change log
Please see the [CHANGELOG](./CHANGELOG.md) for more information on what has changed recently.
## License
[MIT](https://choosealicense.com/licenses/mit/)
[MinimalApi]: https://devblogs.microsoft.com/aspnet/asp-net-core-updates-in-net-6-preview-4/#introducing-minimal-apis