AddOpenApi not respect `JsonSerializerOptions` Configurations

[mu-dawood]

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

I'm configuring my json options using

builder.Services.AddControllers().AddJsonOptions(x =>
            {
                x.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
                x.JsonSerializerOptions.PropertyNamingPolicy = System.Text.Json.JsonNamingPolicy.SnakeCaseLower;
            })
/// add open api
builder.Services.AddOpenApi();

But the generated schema neither respect JsonStringEnumConverter nor SnakeCaseLower

Expected Behavior

No response

Steps To Reproduce

No response

Exceptions (if any)

No response

.NET Version

No response

Anything else?

No response

[martincostello]

This isn't a bug - OpenAPI uses the serialization options associated with HTTP/Minimal APIs, not MVC's.

You need to configure the same serialization customisations for OpenAPI by using the ConfigureHttpOptions method.

[vitasystems]

The usage of this feature is in the best case scenario very confusing and counter intuitive.

In my opinion this is a bug because the behavior that one would expect intuitively is that the AddOpenApi would actually document my controller actions. ConfigureHttpJsonOptions does not work for Controller API only for Minimal API.

Also in my opinion this issue is not resolved. It is also not documented. At best configuring json options twice is a "workaround".

[mu-dawood]

I agree with @vitasystems its a bug
nothing in the documentations said that it works only for minimal Api

The "workaround" fixed my issue but i think it must be fixed or even update the docs

[martincostello]

I suggest creating a new issue in the AspNetCore docs repo to get a clarification added.

I doubt it will be "fixed" as it is working as designed. Otherwise to support MVC it would need to depend on it, meaning pulling significantly more code into apps wanting to use it with Minimal APIs.

[vitasystems]

I suggest creating a new issue in the AspNetCore docs repo to get a clarification added.

I doubt it will be "fixed" as it is working as designed. Otherwise to support MVC it would need to depend on it, meaning pulling significantly more code into apps wanting to use it with Minimal APIs.

You say it is working as designed.... But it is not working for anyone using Controllers API. So it is designed to not work with Controllers API?

What is going to happen when the issue is not just about the Json Options? Does this mean that development of this feature it is solely based on the Minimal API and any one using Controller API should not throw away their investment with this "feature" and just stick to the deprecated (soft deprecated) Swashbuckle?

I mean what are the options here? Microsoft has removed swashbuckle from the templates and suppossedly added OpenAPI support in replacement.

[martincostello]

@captainsafia Would you like to chime in here?

[Rick-Anderson]

@captainsafia Would you like to chime in here?

@captainsafia after you comment I'll update the doc See dotnet/AspNetCore.Docs#34602