A11d.Module
1.0.0
See the version list below for details.
dotnet add package A11d.Module --version 1.0.0
NuGet\Install-Package A11d.Module -Version 1.0.0
<PackageReference Include="A11d.Module" Version="1.0.0" />
paket add A11d.Module --version 1.0.0
#r "nuget: A11d.Module, 1.0.0"
// Install A11d.Module as a Cake Addin #addin nuget:?package=A11d.Module&version=1.0.0 // Install A11d.Module as a Cake Tool #tool nuget:?package=A11d.Module&version=1.0.0
Modules
The goal of this package is to provide a way to organize your application into modules to improve cohesion in your codebase. Each module can configure the services in the installation phase, configure the application and define endpoints in the build phase.
Installation
You can install this package using the following command:
dotnet add package A11d.Modules
API
Modules
The Module
class is the base class for all modules. It provides three virtual methods that you can override to add services, configure the application, and define endpoints:
ConfigureServices
to configure your application using theIServiceCollection
parameter in the installation phase. Calling base is not needed.ConfigureApplication
to configure your application using theWebApplication
parameter in the build phase. Calling base is not needed.ConfigureEndpoints
to define your application endpoints using theIEndpointRouteBuilder
parameter in the build phase. Calling base is not needed.
Application Entry Point
In your program entry point, you have two extension methods to install and configure your modules:
Install
to install your module using theWebApplicationBuilder
parameter in the installation phase.Configure
to configure your module using theWebApplication
parameter in the build phase.
Usage
First, activate the module in the entry point of your application:
// FILE: "./Program.cs"
WebApplication.CreateBuilder(args)
.Install<MyApplication>().Build()
.Configure<MyApplication>().Run();
// This is just a marker class to identify the assembly that contains the modules.
public class MyApplication { }
Then you can create modules to organize your application.
For example, consider a part of your application deals with Accounts and you want to organize it into a module. You can create AccountsModule
:
// FILE "./Accounts/AccountsModule.cs"
namespace MyApplication.Accounts;
// Assuming this module has a DbContext, GetAccount, and AuthenticateAccount command classes.
public class AccountsModule : Module
{
public override void ConfigureServices(IServiceCollection services)
{
services.AddDbContext<AccountDbContext>();
services.AddTransient<GetAccount>();
services.AddTransient<AuthenticateAccount>();
}
public override void ConfigureApplication(WebApplication application)
{
application.UseAuthentication();
application.UseAuthorization();
}
public override void ConfigureEndpoints(IEndpointRouteBuilder endpoints)
{
endpoints.MapGet("/accounts/{id}", (GetAccount getAccount, Guid id) => getAccount.ExecuteAsync(id));
endpoints.MapPost("/accounts/authenticate", (AuthenticateAccount authenticateAccount, AuthenticateAccount.Request request) => authenticateAccount.ExecuteAsync(request));
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. 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. |
-
net8.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.