JsConfig values are not applied on template project

[mikehuber]

Describe the issue

Using the JsConfig class to configure JSON serialization does not seem to have an effect on the template project generated with x new web WebApp.

I specifically tested the JsConfig.TreatEnumAsInteger configuration.

Reproduction

1. Generate new web application

   x new web MyWebApp
   

2. Add enum to Hello.cs and add it as a property in HelloResponse

   public enum SomeEnum 
   {
       One = 1,
       Two = 2
   }
   
   ...
   
   public class HelloResponse
   {
       public required string Result { get; set; }
       public required SomeEnum SomeEnum { get; set; } // <---
   }
   

3. Pass a value in MyServices.cs

   public class MyServices : Service
   {
       public object Any(Hello request)
       {
           return new HelloResponse
           {
               Result = $"Hello, {request.Name}!", 
               SomeEnum = SomeEnum.One // <---
           };
       }
   }
   

4. Configure the serializer to treat enums as integers globally according to the docs in Configure.AppHost.cs

   public override void Configure(Container container)
   {
       JsConfig.Init(new Config
       {
           TreatEnumAsInteger = true,
       });
   }
   

5. Start the application and generate a response for the /hello request.

6. Observe that the response contains the string-representation of the enum instead of the integer-representation

Expected behavior

Setting the JsConfig.TreatEnumAsInteger configuration to true should serialize enum types in response messages as integers.

e.g

{
    "someEnum": 1
}

instead of

{
    "someEnum": "One"
}

System Info

OS: MS Windows 10 Enterprise
.NET Version: .NET 9
ServiceStack Version: 8.6.0

[mythz]

This only configures ServiceStack.Text serializers, i.e. If you’re using Endpoint Routing you’ll be using System.Text.Json APIs instead.

You can control when System.Text JSON is used with the [SystemJson] API, e.g. You can skip using System.Text JSON for a specific API with:

[SystemJson(UseSystemJson.Never)]
public class Hello {}

[mikehuber]

Hello @mythz Thanks for the reply. Indeed, when configuring the System.Text.Json serializer I could manage to enable this behavior.

Can I find this information in the docs somewhere? I suppose I am not the only one being confused by this.

Couldn’t tell by just looking at this docs page

[mythz]

You have limited support for customizing System.Text JSON Serializers with:

builder.Services.ConfigureJsonOptions(options => {
    options.PropertyNamingPolicy = JsonNamingPolicy.SnakeCaseLower;
})
.ApplyToApiJsonOptions()  // Apply to ASP.NET Core's JSON APIs
.ApplyToMvcJsonOptions(); // Apply to MVC

Scoped JSON Configuration only supports a limited configuration subset.

If you need other ServiceStack.Text JSON features you’d need to disable System.Text JSON for that API.

[mikehuber]

Thanks for clarifying!

[mythz]

Also as System.Text.Json is very fragile, any customizations should also be applied to external JsonApiClient’s calling your APIs.

[mythz]

Also ServiceStack uses an enhanced customized System.Text.Json which supports serializing enums as integers by annotating them with the [Flags] attribute:

[Flags]
public enum SomeEnum 
{
    One = 1,
    Two = 2
}