FoxEndpoints 1.0.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package FoxEndpoints --version 1.0.0
NuGet\Install-Package FoxEndpoints -Version 1.0.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="FoxEndpoints" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FoxEndpoints" Version="1.0.0" />
<PackageReference Include="FoxEndpoints" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add FoxEndpoints --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: FoxEndpoints, 1.0.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.
#:package FoxEndpoints@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=FoxEndpoints&version=1.0.0
#tool nuget:?package=FoxEndpoints&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
FoxEndpoints
A lightweight, minimal endpoint library for .NET that provides a clean and simple way to define HTTP endpoints.
Features
- Clean endpoint definition with minimal boilerplate
- Support for endpoints with and without request/response types
- Built-in dependency injection support
- Type-safe routing and parameter binding
- Works with .NET 10.0+
Installation
Coming soon to NuGet.
Usage
Basic Endpoint
public class GetUserEndpoint : Endpoint<GetUserRequest, GetUserResponse>
{
public override void Configure()
{
Get("/users/{id}");
}
public override async Task<IResult> HandleAsync(GetUserRequest request, CancellationToken ct)
{
// Your endpoint logic here
var response = new GetUserResponse
{
Id = request.Id,
Name = "John Doe",
Email = "john.doe@example.com"
};
return await Send.OkAsync(response);
}
}
Early Return with Validation
public override async Task<IResult> HandleAsync(CreateUserRequest request, CancellationToken ct)
{
// Validation with natural early return
if (string.IsNullOrWhiteSpace(request.Name))
{
return await Send.BadRequestAsync("Name is required");
}
var response = CreateUser(request);
return await Send.CreatedAsync(response);
}
Endpoint Without Request
public class GetHealthEndpoint : EndpointWithoutRequest<HealthResponse>
{
public override void Configure()
{
Get("/health");
}
public override async Task<IResult> HandleAsync(CancellationToken ct)
{
var response = new HealthResponse { Status = "Healthy" };
return await Send.OkAsync(response);
}
}
Endpoint Without Response
public class DeleteUserEndpoint : EndpointWithoutResponse<DeleteUserRequest>
{
public override void Configure()
{
Delete("/users/{id}");
}
public override async Task<IResult> HandleAsync(DeleteUserRequest request, CancellationToken ct)
{
// Delete user logic
return await Send.NoContentAsync();
}
}
License
MIT
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- No dependencies.
-
net9.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.