Dev (#30)

* - seperate lifetime configuration setting for endpoints and route group configurators

* - **breaking change** major overhaul of configuration and registration

* - continue configuration overhaul

* - add set accessor to ConfigurationPropertyBag

* - refactor service provider name in configuration context

* - code cleanup

* - rename various classes because naming things is hard

* - move configuration override func parameters out of settings

* - configurator interfaces no longer implement corresponding configuration setting interfaces
- remove configuratoion setting interfaces and replace with configuration parameter classes

* - prune unused code

* - prune unused code

* - replace abstract override configuration properties with methods in both endpoint and route group configurators

* - update docs

* - update docs

* - rename OverrideConfiguration methods to PostConfigure

* - bump version

Author: modabas

Directory.Build.props

@@ -18,6 +18,6 @@
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
 
-    <Version>1.2.0</Version>
+    <Version>1.3.0</Version>
   </PropertyGroup>
 </Project>

README.md

@@ -53,7 +53,7 @@
 
 Each endpoint must implement two virtual methods:
 
-1. **Configure**: Invoked during application startup to define the route and HTTP method for an endpoint. It begins with methods like `MapGet`, `MapPost`, etc., to specify the route pattern. The returned `RouteHandlerBuilder` from the Map[HttpVerb] method can then be used for further endpoint customization.
+1. **Configure**: Invoked during application startup to define the route and HTTP method for an endpoint. It begins with calling input parameter `builder`'s methods like `MapGet`, `MapPost`, etc., to specify the route pattern. The returned `RouteHandlerBuilder` from the Map[HttpVerb] method can then be used for further endpoint customization.
 
 2. **HandleAsync**: Contains the logic to handle incoming requests. Called after the request is validated (if applicable).
 
@@ -126,10 +126,10 @@ internal class HelloWorld
   : MinimalEndpoint<HelloWorldRequest, IResult>
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapGet("MinimalEndpoints/HelloWorld/{Name}")
+    builder.MapGet("MinimalEndpoints/HelloWorld/{Name}")
       .Produces<string>();
   }
 
@@ -164,10 +164,10 @@ internal class GetWeatherForecast : MinimalEndpoint<WeatherForecast[]>
   ];
 
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapGet("/weatherforecast")
+    builder.MapGet("/weatherforecast")
       .WithName("GetWeatherForecast")
       .WithTags("WeatherForecastWebApi");
   }
@@ -203,10 +203,10 @@ internal class ListBooks(ServiceDbContext db)
   : WebResultEndpointWithEmptyRequest<ListBooksResponse>
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapGet("/books")
+    builder.MapGet("/books")
       .Produces<ListBooksResponse>();
   }
 

docs/DisablingComponents.md

@@ -11,10 +11,10 @@ internal class DisabledCustomerFeature
   : MinimalEndpoint<IResult>
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapGet("/disabled/");
+    builder.MapGet("/disabled/");
   }
 
   protected override Task<IResult> HandleAsync(

docs/HandlingFiles.md

@@ -22,10 +22,10 @@ internal class UploadBook
   : WebResultEndpoint<UploadBookRequest, UploadBookResponse>
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapPost("/upload/{Title}")
+    builder.MapPost("/upload/{Title}")
       .DisableAntiforgery()
       .Produces<UploadBookResponse>();
   }
@@ -69,10 +69,10 @@ internal class DownloadCustomers(ServiceDbContext db)
   : MinimalEndpoint<DownloadCustomersRequest, IResult>
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapPost("/download/{FileName}");
+    builder.MapPost("/download/{FileName}");
   }
 
   protected override async Task<IResult> HandleAsync(

docs/IAsyncEnumerableResponse.md

@@ -13,10 +13,10 @@ internal class ListCustomers(ServiceDbContext db)
   : MinimalEndpointWithStreamingResponse<ListCustomersResponse>
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapGet("/");
+    builder.MapGet("/");
   }
 
   protected override IAsyncEnumerable<ListCustomersResponse> HandleAsync(CancellationToken ct)

docs/ParameterBinding.md

@@ -26,10 +26,10 @@ internal class UpdateBook(ServiceDbContext db)
   : WebResultEndpoint<UpdateBookRequest, UpdateBookResponse>
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapPut("/books/{Id}")
+    builder.MapPut("/books/{Id}")
       .Produces<UpdateBookResponse>();
   }
 
@@ -81,10 +81,10 @@ internal class UploadBook
   : WebResultEndpoint<UploadBookRequest, UploadBookResponse>
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapPost("/books/upload/{Title}")
+    builder.MapPost("/books/upload/{Title}")
       .DisableAntiforgery()
       .Produces<UploadBookResponse>();
   }

docs/RequestValidation.md

@@ -28,10 +28,10 @@ internal class GetBookById(ServiceDbContext db)
   : WebResultEndpoint<GetBookByIdRequest, GetBookByIdResponse>
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapGet("/{Id}")
+    builder.MapGet("/{Id}")
       .Produces<GetBookByIdResponse>();
   }
 

docs/RouteGroups.md

@@ -3,7 +3,7 @@
 By default, all endpoints are mapped under root route group. It is possible to define route groups similar to using 'MapGroup' extension method used to map Minimal APIs under a group. Since endpoints are configured by endpoint basis in the 'Configure' method of each endpoint, the approach is a little different than configuring a Minimal API. But route group configuration still utilize Minimal API route groups and can be decorated by any extension method of RouteGroupBuilder. Route groups are also subject to auto discovery and registration, similar to endpoints.
 
 - [Create a route group implementation](../samples/ShowcaseWebApi/Features/FeaturesRouteGroup.cs) by inheriting RouteGroupConfigurator and implementing 'Configure' method,
-- Configuration of each route group implementation starts with calling MapGroup method with a route pattern prefix. The return of 'MapGroup' method, a RouteGroupBuilder instance, can be used to further customize the route group like any Minimal API route group.
+- Configuration of each route group implementation starts with calling input parameter `builder`'s MapGroup method with a route pattern prefix. The return of 'MapGroup' method, a RouteGroupBuilder instance, can be used to further customize the route group like any Minimal API route group.
 - Apply MapToGroup attribute to either other [route group](../samples/ShowcaseWebApi/Features/Books/Configuration/BooksV1RouteGroup.cs) or [endpoint](../samples/ShowcaseWebApi/Features/Books/CreateBook.cs) classes that will be mapped under created route group. Use type of the new route group implementation as GroupType parameter to the attribute.
 
 Following sample creates a parent route group (FeaturesRouteGroup), a child route group under it (BooksV1RouteGroup) and maps an endpoint (CreateBook) to child route group. Group configuration methods used for this particular sample are all part of Minimal APIs ecosystem and are under [Asp.Versioning](https://github.com/dotnet/aspnet-api-versioning).
@@ -12,27 +12,27 @@ Following sample creates a parent route group (FeaturesRouteGroup), a child rout
 internal class FeaturesRouteGroup : RouteGroupConfigurator
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    RouteGroupConfigurationBuilder builder,
+    ConfigurationContext<RouteGroupConfigurationParameters> configurationContext)
   {
-    var builder = MapGroup("/api/v{version:apiVersion}");
-    var apiVersionSet = builder.NewApiVersionSet()
+    var groupBuilder = builder.MapGroup("/api/v{version:apiVersion}");
+    var apiVersionSet = groupBuilder.NewApiVersionSet()
       .HasApiVersion(new ApiVersion(1))
       .HasApiVersion(new ApiVersion(2))
       .ReportApiVersions()
       .Build();
-    builder.WithApiVersionSet(apiVersionSet);
+    groupBuilder.WithApiVersionSet(apiVersionSet);
   }
 }
 
 [MapToGroup<FeaturesRouteGroup>()]
 internal class BooksV1RouteGroup : RouteGroupConfigurator
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    RouteGroupConfigurationBuilder builder,
+    ConfigurationContext<RouteGroupConfigurationParameters> configurationContext)
   {
-    MapGroup("/books")
+    builder.MapGroup("/books")
       .MapToApiVersion(1)
       .WithTags("/BooksV1");
   }
@@ -43,10 +43,10 @@ internal class CreateBook(ServiceDbContext db, ILocationStore location)
   : WebResultEndpoint<CreateBookRequest, CreateBookResponse>
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapPost("/")
+    builder.MapPost("/")
       .Produces<CreateBookResponse>(StatusCodes.Status201Created);
   }
   protected override async Task<Result<CreateBookResponse>> HandleAsync(

docs/WebResultEndpointResponseMapping.md

@@ -11,10 +11,10 @@ internal class GetBookById(ServiceDbContext db)
   : WebResultEndpoint<GetBookByIdRequest, GetBookByIdResponse>
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapGet("/{Id}")
+    builder.MapGet("/{Id}")
       .Produces<GetBookByIdResponse>();
   }
 
@@ -51,10 +51,10 @@ internal class GetBookById
   : WebResultEndpoint<GetBookByIdRequest, GetBookByIdResponse>
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapGet("/{Id}")
+    builder.MapGet("/{Id}")
       .Produces<GetBookByIdResponse>();
   }
 

samples/BenchmarkWebApi/Features/MinimalEndpoints/BasicTest.cs

@@ -6,10 +6,10 @@ internal class BasicTest
   : MinimalEndpoint<IResult>
 {
   protected override void Configure(
-    IServiceProvider serviceProvider,
-    IRouteGroupConfigurator? parentRouteGroup)
+    EndpointConfigurationBuilder builder,
+    ConfigurationContext<EndpointConfigurationParameters> configurationContext)
   {
-    MapGet("/MinimalEndpoints/BasicTest")
+    builder.MapGet("/MinimalEndpoints/BasicTest")
       .Produces<string>();
   }