Merge pull request #79 from cnblogs/78-use-enum-replace-bool

refactor!: use enum to present map nullable route parameter

Author: ikesnowy

src/Cnblogs.Architecture.Ddd.Cqrs.AspNetCore/Cnblogs.Architecture.Ddd.Cqrs.AspNetCore.csproj

@@ -7,11 +7,11 @@
     </Description>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" Version="7.0.0"/>
-    <PackageReference Include="Serilog.AspNetCore" Version="6.1.0"/>
+    <PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" Version="7.0.0" />
+    <PackageReference Include="Serilog.AspNetCore" Version="6.1.0" />
   </ItemGroup>
   <ItemGroup>
-    <ProjectReference Include="..\Cnblogs.Architecture.Ddd.Cqrs.Abstractions\Cnblogs.Architecture.Ddd.Cqrs.Abstractions.csproj"/>
-    <ProjectReference Include="..\Cnblogs.Architecture.Ddd.Cqrs.DependencyInjection\Cnblogs.Architecture.Ddd.Cqrs.DependencyInjection.csproj"/>
+    <ProjectReference Include="..\Cnblogs.Architecture.Ddd.Cqrs.Abstractions\Cnblogs.Architecture.Ddd.Cqrs.Abstractions.csproj" />
+    <ProjectReference Include="..\Cnblogs.Architecture.Ddd.Cqrs.DependencyInjection\Cnblogs.Architecture.Ddd.Cqrs.DependencyInjection.csproj" />
   </ItemGroup>
 </Project>

src/Cnblogs.Architecture.Ddd.Cqrs.AspNetCore/CqrsRouteMapper.cs

@@ -43,7 +43,7 @@ public static class CqrsRouteMapper
     public static IEndpointConventionBuilder MapQuery<T>(
         this IEndpointRouteBuilder app,
         [StringSyntax("Route")] string route,
-        bool mapNullableRouteParameters = false,
+        MapNullableRouteParameter mapNullableRouteParameters = MapNullableRouteParameter.Disable,
         string nullRouteParameterPattern = "-")
     {
         return app.MapQuery(
@@ -79,7 +79,7 @@ public static IEndpointConventionBuilder MapQuery(
         this IEndpointRouteBuilder app,
         [StringSyntax("Route")] string route,
         Delegate handler,
-        bool mapNullableRouteParameters = false,
+        MapNullableRouteParameter mapNullableRouteParameters = MapNullableRouteParameter.Disable,
         string nullRouteParameterPattern = "-")
     {
         var isQuery = handler.Method.ReturnType.GetInterfaces().Where(x => x.IsGenericType)
@@ -90,7 +90,7 @@ public static IEndpointConventionBuilder MapQuery(
                 "delegate does not return a query, please make sure it returns object that implement IQuery<> or IListQuery<> or interface that inherit from them");
         }
 
-        if (mapNullableRouteParameters == false)
+        if (mapNullableRouteParameters is MapNullableRouteParameter.Disable)
         {
             return app.MapGet(route, handler).AddEndpointFilter<QueryEndpointHandler>();
         }

src/Cnblogs.Architecture.Ddd.Cqrs.AspNetCore/MapNullableRouteParameter.cs

@@ -0,0 +1,17 @@
+namespace Cnblogs.Architecture.Ddd.Cqrs.AspNetCore;
+
+/// <summary>
+///     Defines behavior for nullable route parameters.
+/// </summary>
+public enum MapNullableRouteParameter
+{
+    /// <summary>
+    ///     Map different routes to present <c>null</c> for nullable route parameters.
+    /// </summary>
+    Enable = 1,
+
+    /// <summary>
+    ///     Do not map extra route for nullable route parameters.
+    /// </summary>
+    Disable = 2
+}

test/Cnblogs.Architecture.IntegrationTestProject/Program.cs

@@ -35,7 +35,7 @@
 
 var apis = app.NewVersionedApi();
 var v1 = apis.MapGroup("/api/v{version:apiVersion}").HasApiVersion(1);
-v1.MapQuery<GetStringQuery>("apps/{appId}/strings/{stringId:int}/value", true);
+v1.MapQuery<GetStringQuery>("apps/{appId}/strings/{stringId:int}/value", MapNullableRouteParameter.Enable);
 v1.MapQuery<GetStringQuery>("strings/{id:int}");
 v1.MapQuery<ListStringsQuery>("strings");
 v1.MapCommand("strings", (CreatePayload payload) => new CreateCommand(payload.NeedError));