feat(notifications): add custom API conventions configuration for snake_case and kebab-case

Author: matheusfsc28

src/DotCruz.Notifications.Api/Configurations/ApiConventionsConfiguration.cs

@@ -0,0 +1,102 @@
+using DotCruz.Notifications.Api.Filters;
+using Microsoft.AspNetCore.Mvc.ApplicationModels;
+using Microsoft.AspNetCore.Mvc.ModelBinding;
+using System.Globalization;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using System.Text.RegularExpressions;
+
+namespace DotCruz.Notifications.Api.Configurations;
+
+public static class ApiConventionsConfiguration
+{
+    public static IMvcBuilder AddApiConventions(this IServiceCollection services)
+    {
+        services.ConfigureHttpJsonOptions(options =>
+        {
+            options.SerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.SnakeCaseLower;
+            options.SerializerOptions.DictionaryKeyPolicy = JsonNamingPolicy.SnakeCaseLower;
+            options.SerializerOptions.Converters.Add(new JsonStringEnumConverter());
+        });
+
+        return services
+            .AddControllers(options =>
+            {
+                options.Filters.Add<ExceptionFilter>();
+
+                options.Conventions.Add(
+                    new RouteTokenTransformerConvention(new KebabCaseParameterTransformer()));
+
+                ReplaceQueryValueProvider(options.ValueProviderFactories);
+            })
+            .AddJsonOptions(options =>
+            {
+                options.JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.SnakeCaseLower;
+                options.JsonSerializerOptions.DictionaryKeyPolicy = JsonNamingPolicy.SnakeCaseLower;
+                options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
+            });
+    }
+
+    private static void ReplaceQueryValueProvider(IList<IValueProviderFactory> factories)
+    {
+        var defaultFactory = factories.OfType<QueryStringValueProviderFactory>().FirstOrDefault();
+
+        if (defaultFactory is null)
+        {
+            factories.Add(new SnakeCaseQueryValueProviderFactory());
+            return;
+        }
+
+        var index = factories.IndexOf(defaultFactory);
+        factories[index] = new SnakeCaseQueryValueProviderFactory();
+    }
+}
+
+public sealed partial class KebabCaseParameterTransformer : IOutboundParameterTransformer
+{
+    public string? TransformOutbound(object? value)
+    {
+        var input = value?.ToString();
+
+        return string.IsNullOrEmpty(input)
+            ? input
+            : WordBoundaryRegex().Replace(input, "$1-$2").ToLowerInvariant();
+    }
+
+    [GeneratedRegex("([a-z0-9])([A-Z])")]
+    private static partial Regex WordBoundaryRegex();
+}
+
+public sealed class SnakeCaseQueryValueProviderFactory : IValueProviderFactory
+{
+    public Task CreateValueProviderAsync(ValueProviderFactoryContext context)
+    {
+        ArgumentNullException.ThrowIfNull(context);
+
+        var query = context.ActionContext.HttpContext.Request.Query;
+        context.ValueProviders.Add(
+            new SnakeCaseQueryValueProvider(BindingSource.Query, query, CultureInfo.InvariantCulture));
+
+        return Task.CompletedTask;
+    }
+}
+
+public sealed class SnakeCaseQueryValueProvider(
+    BindingSource bindingSource,
+    IQueryCollection values,
+    CultureInfo culture) : QueryStringValueProvider(bindingSource, values, culture)
+{
+    public override bool ContainsPrefix(string prefix) => base.ContainsPrefix(ToSnakeCase(prefix));
+
+    public override ValueProviderResult GetValue(string key) => base.GetValue(ToSnakeCase(key));
+
+    private static string ToSnakeCase(string key)
+    {
+        if (string.IsNullOrEmpty(key))
+        {
+            return key;
+        }
+
+        return string.Join('.', key.Split('.').Select(JsonNamingPolicy.SnakeCaseLower.ConvertName));
+    }
+}

src/DotCruz.Notifications.Api/Program.cs

@@ -1,4 +1,4 @@
-using System.Text.Json.Serialization;
+using DotCruz.Notifications.Api.Configurations;
 using DotCruz.Notifications.Api.Filters;
 using DotCruz.Notifications.Api.Middlewares;
 using DotCruz.Notifications.Application;
@@ -12,15 +12,7 @@
 
 // Add services to the container.
 
-builder.Services.AddControllers().AddJsonOptions(options =>
-{
-    options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
-});
-
-builder.Services.ConfigureHttpJsonOptions(options =>
-{
-    options.SerializerOptions.Converters.Add(new JsonStringEnumConverter());
-});
+builder.Services.AddApiConventions();
 
 // Learn more about configuring OpenAPI at https://aka.ms/aspnet/openapi
 builder.Services.AddOpenApi();
@@ -32,7 +24,7 @@
 builder.Services.AddApplication();
 builder.Services.AddInfrastructure(builder.Configuration);
 
-builder.Services.AddMvc(options => options.Filters.Add<ExceptionFilter>());
+
 
 var app = builder.Build();
 

tests/WebApi.Test/NotificationClassFixture.cs

@@ -1,5 +1,6 @@
 using System.Net.Http.Headers;
 using System.Net.Http.Json;
+using System.Text.Json;
 
 namespace WebApi.Test;
 
@@ -8,6 +9,12 @@ public class NotificationClassFixture : IClassFixture<CustomWebApplicationFactor
     private readonly HttpClient _httpClient;
     private readonly CustomWebApplicationFactory _factory;
 
+    private static readonly JsonSerializerOptions JsonSerializerOptions = new()
+    {
+        PropertyNamingPolicy = JsonNamingPolicy.SnakeCaseLower,
+        DictionaryKeyPolicy = JsonNamingPolicy.SnakeCaseLower
+    };
+
     public NotificationClassFixture(CustomWebApplicationFactory factory)
     {
         _httpClient = factory.CreateClient();
@@ -24,15 +31,15 @@ protected async Task<HttpResponseMessage> DoPost(
         ChangeRequestCulture(culture);
         AuthorizeRequest(token);
 
-        return await _httpClient.PostAsJsonAsync(endpoint, request);
+        return await _httpClient.PostAsJsonAsync(endpoint, request, JsonSerializerOptions);
     }
 
     protected async Task<HttpResponseMessage> DoPut(string method, object request, string token, string culture = "en")
     {
         ChangeRequestCulture(culture);
         AuthorizeRequest(token);
 
-        return await _httpClient.PutAsJsonAsync(method, request);
+        return await _httpClient.PutAsJsonAsync(method, request, JsonSerializerOptions);
     }
 
     protected async Task<HttpResponseMessage> DoDelete(string method, string token, string culture = "en")