apply pr suggestions

Author: ItsVeryWindy

README.md

@@ -114,14 +114,15 @@ In versions of Swashbuckle.AspNetCore prior to `5.0.0`, Swashbuckle would genera
 on the behavior of the [Newtonsoft.Json serializer][newtonsoft-json]. This made sense because that was the serializer that shipped with ASP.NET Core
 at the time. However, since ASP.NET Core 3.0, ASP.NET Core introduces a new serializer, [System.Text.Json (STJ)][system-text-json] out-of-the-box.
 
-If you find that the *STJ* options/attributes are not being honored, this may be because you are using a combination of minimal apis and mvc which have separate json options.
-To force the swagger generation to use either set of json options you can use one of the following methods.
+If you find that the *STJ* options/attributes are not being honored, this may be because you are using a combination of Minimal APIs and MVC, which have separate JSON options.
+To force the OpenAPI document generation to use either set of JSON options you can use one of the following methods:
 
 ```csharp
 services.AddSwaggerGen(c =>
 {
     c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
 });
+// Then either:
 services.AddSwaggerGenMinimalApisJsonOptions();
 // or ...
 services.AddSwaggerGenMvcJsonOptions();

src/Swashbuckle.AspNetCore.SwaggerGen/DependencyInjection/ConfigureSwaggerGenJsonOptions.cs

@@ -31,6 +31,7 @@ public void PostConfigure(string name, SwaggerGenJsonOptions options)
             return;
         }
 
+#if NET
         /*
          * There is no surefire way to do this.
          * However, both JsonOptions are defaulted in the same way.
@@ -43,7 +44,6 @@ public void PostConfigure(string name, SwaggerGenJsonOptions options)
          * a last resort as this is an expensive operation.
          */
 
-#if NET
         var serializerOptions = _mvcJsonOptions.JsonSerializerOptions ?? JsonSerializerOptions.Default;
 
         if (_minimalApiConfigureOptions.Any() || _minimalApiPostConfigureOptions.Any())

src/Swashbuckle.AspNetCore.SwaggerGen/DependencyInjection/SwaggerGenJsonOptions.cs

@@ -8,7 +8,7 @@ namespace Swashbuckle.AspNetCore.SwaggerGen.DependencyInjection;
 public class SwaggerGenJsonOptions
 {
     /// <summary>
-    /// Gets or Sets the json serializer options used by <see cref="JsonSerializerDataContractResolver"/>. 
+    /// Gets or sets the JSON serializer options to use.
     /// </summary>
     public JsonSerializerOptions SerializerOptions { get; set; }
 }

test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGenJsonOptionsTests.cs

@@ -6,6 +6,9 @@
 using Swashbuckle.AspNetCore.SwaggerGen.DependencyInjection;
 using Swashbuckle.AspNetCore.SwaggerGen.Test.Fixtures;
 
+using MinimalApiJsonOptions = Microsoft.AspNetCore.Http.Json.JsonOptions;
+using MvcJsonOptions = Microsoft.AspNetCore.Mvc.JsonOptions;
+
 namespace Swashbuckle.AspNetCore.SwaggerGen.Test;
 
 public class SwaggerGenJsonOptionsTests
@@ -16,80 +19,60 @@ public static void Ensure_SwaggerGenJsonOptions_Uses_MinimalApi_JsonOptions_When
         var services = new ServiceCollection();
         services.AddSingleton<IWebHostEnvironment, DummyHostEnvironment>();
         services.AddSwaggerGen();
-        services.AddMvcCore().AddJsonOptions(o => o.JsonSerializerOptions.Converters.Add(new DummyConverter()));
+        services.AddMvcCore().AddJsonOptions(o => o.JsonSerializerOptions.AllowTrailingCommas = true);
         services.AddSwaggerGenMinimalApisJsonOptions();
 
         using var provider = services.BuildServiceProvider();
 
-        var swaggerGenConverters = provider.GetService<IOptions<SwaggerGenJsonOptions>>().Value.SerializerOptions.Converters;
-
-        Assert.Empty(swaggerGenConverters);
+        var minimalApiJsonOptions = provider.GetService<IOptions<MinimalApiJsonOptions>>().Value.SerializerOptions;
+        var swaggerGenSerializerOptions = provider.GetService<IOptions<SwaggerGenJsonOptions>>().Value.SerializerOptions;
+        Assert.Equal(minimalApiJsonOptions, swaggerGenSerializerOptions);
     }
 
     [Fact]
     public static void Ensure_SwaggerGenJsonOptions_Uses_Mvc_JsonOptions_When_Overridden()
     {
-        var expectedDummyConverter = new DummyConverter();
-
         var services = new ServiceCollection();
         services.AddSingleton<IWebHostEnvironment, DummyHostEnvironment>();
         services.AddSwaggerGen();
-        services.ConfigureHttpJsonOptions(o => o.SerializerOptions.Converters.Add(new DummyConverter()));
-        services.AddMvcCore().AddJsonOptions(o => o.JsonSerializerOptions.Converters.Add(expectedDummyConverter));
+        services.ConfigureHttpJsonOptions(o => o.SerializerOptions.AllowTrailingCommas = true);
         services.AddSwaggerGenMvcJsonOptions();
 
         using var provider = services.BuildServiceProvider();
 
-        var swaggerGenDummyConverter = provider.GetService<IOptions<SwaggerGenJsonOptions>>().Value.SerializerOptions.Converters.FirstOrDefault();
-
-        Assert.Equal(expectedDummyConverter, swaggerGenDummyConverter);
+        var mvcJsonOptions = provider.GetService<IOptions<MvcJsonOptions>>().Value.JsonSerializerOptions;
+        var swaggerGenSerializerOptions = provider.GetService<IOptions<SwaggerGenJsonOptions>>().Value.SerializerOptions;
+        Assert.Equal(mvcJsonOptions, swaggerGenSerializerOptions);
     }
 
     [Fact]
     public static void Ensure_SwaggerGenJsonOptions_Uses_Mvc_JsonOptions_When_Not_Using_Minimal_Apis()
     {
-        var expectedDummyConverter = new DummyConverter();
-
         var services = new ServiceCollection();
         services.AddSingleton<IWebHostEnvironment, DummyHostEnvironment>();
         services.AddSwaggerGen();
-        services.AddMvcCore().AddJsonOptions(o => o.JsonSerializerOptions.Converters.Add(expectedDummyConverter));
+        services.AddMvcCore().AddJsonOptions(o => o.JsonSerializerOptions.AllowTrailingCommas = true);
 
         using var provider = services.BuildServiceProvider();
 
-        var swaggerGenDummyConverter = provider.GetService<IOptions<SwaggerGenJsonOptions>>().Value.SerializerOptions.Converters.FirstOrDefault();
-
-        Assert.Equal(expectedDummyConverter, swaggerGenDummyConverter);
+        var mvcJsonOptions = provider.GetService<IOptions<MvcJsonOptions>>().Value.JsonSerializerOptions;
+        var swaggerGenSerializerOptions = provider.GetService<IOptions<SwaggerGenJsonOptions>>().Value.SerializerOptions;
+        Assert.Equal(mvcJsonOptions, swaggerGenSerializerOptions);
     }
 
     [Fact]
     public static void Ensure_SwaggerGenJsonOptions_Uses_MinimalApi_JsonOptions_When_Configured()
     {
-        var expectedDummyConverter = new DummyConverter();
-
         var services = new ServiceCollection();
         services.AddSingleton<IWebHostEnvironment, DummyHostEnvironment>();
         services.AddSwaggerGen();
-        services.ConfigureHttpJsonOptions(o => o.SerializerOptions.Converters.Add(expectedDummyConverter));
-        services.AddMvcCore().AddJsonOptions(o => o.JsonSerializerOptions.Converters.Add(new DummyConverter()));
+        services.ConfigureHttpJsonOptions(o => o.SerializerOptions.AllowTrailingCommas = true);
+        services.AddMvcCore().AddJsonOptions(o => o.JsonSerializerOptions.AllowTrailingCommas = true);
 
         using var provider = services.BuildServiceProvider();
 
-        var swaggerGenDummyConverter = provider.GetService<IOptions<SwaggerGenJsonOptions>>().Value.SerializerOptions.Converters.FirstOrDefault();
-
-        Assert.Equal(expectedDummyConverter, swaggerGenDummyConverter);
-    }
-
-    private sealed class DummyConverter : JsonConverter<object>
-    {
-        public override object Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
-        {
-            throw new NotImplementedException();
-        }
-
-        public override void Write(Utf8JsonWriter writer, object value, JsonSerializerOptions options)
-        {
-            throw new NotImplementedException();
-        }
+        var minimalApiJsonOptions = provider.GetService<IOptions<MinimalApiJsonOptions>>().Value.SerializerOptions;
+        var swaggerGenSerializerOptions = provider.GetService<IOptions<SwaggerGenJsonOptions>>().Value.SerializerOptions;
+        Assert.Equal(minimalApiJsonOptions, swaggerGenSerializerOptions);
     }
 }

test/WebSites/Basic/Startup.cs

@@ -42,6 +42,8 @@ public void ConfigureServices(IServiceCollection services)
 
             c.EnableAnnotations();
         });
+
+        services.AddSwaggerGenMinimalApisJsonOptions();
     }
 
     // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.

test/WebSites/MinimalAppWithHostedServices/Program.cs

@@ -6,6 +6,8 @@
     c.SwaggerDoc("v1", new() { Title = "MinimalApp", Version = "v1" });
 });
 
+builder.Services.AddSwaggerGenMinimalApisJsonOptions();
+
 builder.Services.AddHostedService<HostedService>();
 
 var app = builder.Build();