MinimalApi.Endpoints
1.3.0
See the version list below for details.
dotnet add package MinimalApi.Endpoints --version 1.3.0
NuGet\Install-Package MinimalApi.Endpoints -Version 1.3.0
<PackageReference Include="MinimalApi.Endpoints" Version="1.3.0" />
paket add MinimalApi.Endpoints --version 1.3.0
#r "nuget: MinimalApi.Endpoints, 1.3.0"
// Install MinimalApi.Endpoints as a Cake Addin #addin nuget:?package=MinimalApi.Endpoints&version=1.3.0 // Install MinimalApi.Endpoints as a Cake Tool #tool nuget:?package=MinimalApi.Endpoints&version=1.3.0
MinimalApi.Endpoints
MinimalApi.Endpoints is a package that allows you to easily structure your Minimal Api Endpoints in individual classes instead of having them all in Program.cs
.
Installation
You can install MinimalApi.Endpoints via NuGet Package Manager in Visual Studio or by using the following command:
dotnet add package MinimalApi.Endpoints
Usage
Simply call AddEndpoints
and MapEndpoints
extension methods in your Program.cs
:
using MinimalApi;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddEndpoints();
var app = builder.Build();
app.MapEndpoints();
app.Run();
Then create a simple class that contains a method decorated with EndpointGet
attribute:
public class GetUser
{
[EndpointGet("/users/{id}")]
public async Task<User> GetAsync(int id, DataContext data)
{
return await data.Users.FindAsync(id);
}
}
You have the freedom to place the class anywhere within your project, utilizing any name you prefer. Similarly, you can name the method in whichever way you find suitable. Only requirement is to use appropriate Endpoint attribute.
More examples
Here are some examples of using EndpointPost
and EndpointPut
:
public class CreateUser
{
[EndpointPost("/users")]
public async Task<User> PostAsync(User user, DataContext data)
{
data.Users.Add(user);
await data.SaveChangesAsync();
return user;
}
}
public class UpdateUser
{
[EndpointPut("/users/{id}")]
public async Task<User> PutAsync(int id, User updatedUser, DataContext data)
{
var user = await data.Users.FindAsync(id);
user.Name = updatedUser.Name;
user.Email = updatedUser.Email;
await data.SaveChangesAsync();
return user;
}
}
I want Controllers!
If you rather prefer to have all methods in one class:
public class WannaBeUserController
{
private readonly DataContext _data;
public WannaBeUserController(DataContext data)
{
_data = data;
}
[EndpointGet("/users/{id}")]
public async Task<User> GetAsync(int id)
{
return await _data.Users.FindAsync(id);
}
[EndpointPost("/users")]
public async Task<User> PostAsync(User user)
{
_data.Users.Add(user);
await _data.SaveChangesAsync();
return user;
}
[EndpointPut("/users/{id}")]
public async Task<User> PutAsync(int id, User updatedUser)
{
var user = await _data.Users.FindAsync(id);
user.Name = updatedUser.Name;
user.Email = updatedUser.Email;
await _data.SaveChangesAsync();
return user;
}
}
Method parameters
The method parameters can resolve to route/query/body values and registered services from the dependency container.
Supported Endpoint attributes
EndpointGet
EndpointPost
EndpointPut
EndpointPatch
EndpointDelete
License
MinimalApi.Endpoints is licensed under the MIT license.
Product | Versions 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. |
-
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.