Preserve casing for fields in DTOs

[jiexunxu]

Hi,

When I try to use the following attribute to generate async api schemas from my DTO objects like MyMessage

 [Operation("sendMessage", V3OperationAction.Send, "#/channels/myTopic", Description = "Send message", MessagePayloadType=typeof(MyMessage))]

The generated async api schemas recognize all the properties and their descriptions. However, the case of the first letter is always lowered, from Id to id, and from MailAddress to mailAddress:

"sendMessageRequest": {
          "payload": {
            "schema": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id of the message"
                },
                "mailAddress": {
                  "type": "string",
                  "description": "Mail Address"
                },

This is the MyMessage class in my application

public record MyMessage 
{
    [Description("Id of the message")]
    public string Id { get; set;}
    
    [Description("Mail Address")]
    public string MailAddress { get; set;}

    ...
}

Is there a way to preserve the casing of these properties? Thanks

[cdavernas]

@jiexunxu This is as expected, camel casing being the unofficial norm for serdes. If you want to enforce your own casing, you can do so in two different ways.

1. Decorate your properties with attributes:

public record MyMessage 
{
    [Description("Id of the message")]
    [JsonPropertyName("Id"), YamlMember(Alias = "Id")]
    public string Id { get; set;}
    
    [Description("Mail Address")]
    [JsonPropertyName("MailAddress"), YamlMember(Alias = "MailAddress")]
    public string MailAddress { get; set;}

    ...
}

2. Configure serialization globally, by registering serialization services before any AddAsyncApi* methods:

services.AddJsonSerializer(options =>
{
    options.PropertyNamingPolicy = null;
});
services.AddYamlDotNetSerializer(options =>
{
    YamlSerializer.DefaultSerializerConfiguration(options.Serializer);
    options.Serializer.WithNamingConvention(NullNamingConvention.Instance);
});

[jiexunxu]

Hey @cdavernas, thanks for the suggestions. I tried both, the 1st suggestion work, but the 2nd one doesn't seem to do anything (for both Json and Yaml). I tried different variants like

builder.Services.AddControllers()
            .AddJsonOptions(options =>
            {
                options.JsonSerializerOptions.PropertyNamingPolicy = null;
            });

as well, and I tried putting these either before or after the

services.AddAsyncApiGeneration(...)

But none of the above seem to work. While the 1st suggestion would work, ideally getting the 2nd suggestion would be better, could you take a look at this further? Thanks.

On another note, thanks for releasing 3.0.5! I can verify that the /asyncapi/3.0.0/asp-async-api/1.0.0/doc.json endpoint is producing valid json now which I can copy and paste into AsyncApi studio.

[cdavernas]

@jiexunxu Can you give me the whole contents of your Program.cs?

[jiexunxu]

Sure, this is the content of Program.cs

var host = Host.CreateDefaultBuilder(args)
    .ConfigureServices(
        services =>
        {
            services.AddJsonSerializer(options =>
            {
                options.PropertyNamingPolicy = null;
            });
            services.AddYamlDotNetSerializer(options =>
            {
                YamlSerializer.DefaultSerializerConfiguration(options.Serializer);
                options.Serializer.WithNamingConvention(NullNamingConvention.Instance);
            });

            services.AddHttpClient();
            services.AddRazorPages();
            services.AddAsyncApiUI();
            services.AddAsyncApiGeneration(builder => builder
                .WithMarkupType<MyService>());
            services.AddSingleton<IJsonSchemaResolver, Neuroglia.Data.Schemas.Json.JsonSchemaResolver>();
        })
    .ConfigureWebHostDefaults(
        webBuilder =>
        {
            webBuilder
                .Configure(
                    (ctx, app) =>
                    {
                        if (ctx.HostingEnvironment.IsDevelopment())
                        {
                            app.UseDeveloperExceptionPage();
                        }

                        app.UseStaticFiles();

                        app.UseRouting();

                        app.UseAuthorization();

                        app.UseHttpMetrics();

                        app.MapAsyncApiDocuments();

                        app.UseEndpoints(
                            endpoints =>
                            {
                                endpoints.MapHealthChecks("/health");
                                endpoints.MapMetrics();
                                endpoints.MapRazorPages();
                                    });
                            });
                    });
        })
    .Build();

host.Run();

[cdavernas]

Ok, sorry the issue seem related to:

net-sdk/src/Neuroglia.AsyncApi.AspNetCore.UI/Pages/Shared/v3/_V3Schema.cshtml

Line 40 in 6c2565e

Neuroglia.Serialization.Json.JsonSerializer.DefaultOptionsConfiguration(serializationOptions);

Can you please check if doing the following anywhere in your Program.cs addresses your issue?

var defaultConfiguration = JsonSerializer.DefaultOptionsConfiguration;
JsonSerializer.DefaultOptionsConfiguration = options =>
{
    defaultConfiguration(options);
    options.PropertyNamingPolicy = null;
};

[jiexunxu]

No problem, I tried adding the above at the before and after services.AddAsyncApiGeneration, and also tried keeping and removing

services.AddJsonSerializer(options =>
            {
                options.PropertyNamingPolicy = null;
            });
            services.AddYamlDotNetSerializer(options =>
            {
                YamlSerializer.DefaultSerializerConfiguration(options.Serializer);
                options.Serializer.WithNamingConvention(NullNamingConvention.Instance);
            });

But none of them seem to affect the produced json