MWTech.Dotnet.WebApp.Helpers 1.0.0.4

MWTech.Dotnet.WebApp.Helpers

Extension methods and utilities for ASP.NET Core WebApplication builders and applications, simplifying common configuration and setup tasks.

Features

WebApplicationBuilder Extensions

• RegisterConfigSection: Bind and register configuration sections in DI with custom lifetimes
• Automatic validation of configuration existence
• Support for Singleton, Scoped, and Transient lifetimes

WebApplication Extensions

• RegisterFileServer: Configure static file serving with custom paths and directory browsing
• Flexible file provider setup
• Optional directory browsing

Installation

Copy the following files into your ASP.NET Core project:

• Extensions/WebApplicationBuilderExtensions.cs
• Extensions/WebApplicationExtensions.cs
• GlobalUsings.cs

Usage

Registering Configuration Sections

using MWTech.Dotnet.WebApp.Helpers.Extensions;

var builder = WebApplication.CreateBuilder(args);

// Register a configuration section with default singleton lifetime
var myConfig = builder.RegisterConfigSection<MyConfig>();

// Or specify custom section name and lifetime
var dbConfig = builder.RegisterConfigSection<DatabaseConfig>(
    "Database", 
    ServiceLifetime.Scoped
);

// Configuration is now available in DI
builder.Services.AddScoped<MyService>();

In appsettings.json:

{
  "MyConfig": {
    "Setting1": "value1",
    "Setting2": "value2"
  },
  "Database": {
    "ConnectionString": "Server=.;Database=MyDb;..."
  }
}

Setting Up File Server

var app = builder.Build();

// Register file server for wwwroot with default settings
app.RegisterFileServer();

// Or specify custom root path and request path
app.RegisterFileServer(
    rootPath: Path.Combine(Directory.GetCurrentDirectory(), "static"),
    requestPath: "static",
    enableDirectoryBrowsing: true
);

app.Run();

This serves files from:

• URL: https://yourapp.com/static/
• Physical path: YourApp/static/
• With directory browsing enabled

Extension Methods

WebApplicationBuilder.RegisterConfigSection<T>

public static T RegisterConfigSection<T>(
    this WebApplicationBuilder builder,
    string? sectionName = null,
    ServiceLifetime lifetime = ServiceLifetime.Singleton)
    where T : class, new()

Parameters:

• sectionName: Configuration section name (defaults to class name)
• lifetime: DI lifetime for the registered service

Throws:

• InvalidOperationException if configuration section doesn't exist

WebApplication.RegisterFileServer

public static WebApplication RegisterFileServer(
    this WebApplication app,
    string? rootPath = null,
    string? requestPath = null,
    bool enableDirectoryBrowsing = false)

Parameters:

• rootPath: Physical directory path (defaults to wwwroot)
• requestPath: URL path segment (defaults to root /)
• enableDirectoryBrowsing: Whether to show directory listings

Global Usings

Includes common ASP.NET Core usings:

global using Microsoft.AspNetCore.Builder;
global using Microsoft.AspNetCore.Http;
global using Microsoft.Extensions.Configuration;
global using Microsoft.Extensions.DependencyInjection;
global using Microsoft.Extensions.FileProviders;
global using MWTech.Dotnet.Common.Helpers.Extensions;

Benefits

• Type Safety: Strongly-typed configuration binding
• Validation: Automatic configuration section validation
• Flexibility: Custom lifetimes and paths
• Convenience: Reduces boilerplate code
• Integration: Works seamlessly with existing ASP.NET Core patterns

Dependencies

• Microsoft.AspNetCore.App
• MWTech.Dotnet.Common.Helpers (for shared extensions)

License

MIT License