Remove the need for a workaround for "dotnet swagger" (swashbuckle.aspnetcore.cli global tool)

Author: bkoelman

src/JsonApiDotNetCore.OpenApi.Swashbuckle/ConfigureMvcOptions.cs

@@ -1,45 +1,29 @@
 using JsonApiDotNetCore.Configuration;
-using JsonApiDotNetCore.Middleware;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Options;
 
 namespace JsonApiDotNetCore.OpenApi.Swashbuckle;
 
 internal sealed class ConfigureMvcOptions : IConfigureOptions<MvcOptions>
 {
-    private readonly IJsonApiRoutingConvention _jsonApiRoutingConvention;
     private readonly JsonApiRequestFormatMetadataProvider _jsonApiRequestFormatMetadataProvider;
-    private readonly IJsonApiOptions _jsonApiOptions;
+    private readonly JsonApiOptions _jsonApiOptions;
 
-    public ConfigureMvcOptions(IJsonApiRoutingConvention jsonApiRoutingConvention, JsonApiRequestFormatMetadataProvider jsonApiRequestFormatMetadataProvider,
-        IJsonApiOptions jsonApiOptions)
+    public ConfigureMvcOptions(JsonApiRequestFormatMetadataProvider jsonApiRequestFormatMetadataProvider, IJsonApiOptions jsonApiOptions)
     {
-        ArgumentNullException.ThrowIfNull(jsonApiRoutingConvention);
         ArgumentNullException.ThrowIfNull(jsonApiRequestFormatMetadataProvider);
         ArgumentNullException.ThrowIfNull(jsonApiOptions);
 
-        _jsonApiRoutingConvention = jsonApiRoutingConvention;
         _jsonApiRequestFormatMetadataProvider = jsonApiRequestFormatMetadataProvider;
-        _jsonApiOptions = jsonApiOptions;
+        _jsonApiOptions = (JsonApiOptions)jsonApiOptions;
     }
 
     public void Configure(MvcOptions options)
     {
         ArgumentNullException.ThrowIfNull(options);
 
-        AddSwashbuckleCliCompatibility(options);
-
         options.InputFormatters.Add(_jsonApiRequestFormatMetadataProvider);
 
-        ((JsonApiOptions)_jsonApiOptions).IncludeExtensions(OpenApiMediaTypeExtension.OpenApi, OpenApiMediaTypeExtension.RelaxedOpenApi);
-    }
-
-    private void AddSwashbuckleCliCompatibility(MvcOptions options)
-    {
-        if (!options.Conventions.Any(convention => convention is IJsonApiRoutingConvention))
-        {
-            // See https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/1957 for why this is needed.
-            options.Conventions.Insert(0, _jsonApiRoutingConvention);
-        }
+        _jsonApiOptions.IncludeExtensions(OpenApiMediaTypeExtension.OpenApi, OpenApiMediaTypeExtension.RelaxedOpenApi);
     }
 }

src/JsonApiDotNetCore.OpenApi.Swashbuckle/ServiceCollectionExtensions.cs

@@ -62,7 +62,7 @@ private static void AddCustomApiExplorer(IServiceCollection services)
 
         AddApiExplorer(services);
 
-        services.AddSingleton<IConfigureOptions<MvcOptions>, ConfigureMvcOptions>();
+        services.TryAddEnumerable(ServiceDescriptor.Singleton<IConfigureOptions<MvcOptions>, ConfigureMvcOptions>());
     }
 
     private static void AddApiExplorer(IServiceCollection services)

src/JsonApiDotNetCore/Configuration/ApplicationBuilderExtensions.cs

@@ -33,20 +33,6 @@ public static void UseJsonApi(this IApplicationBuilder builder)
             inverseNavigationResolver.Resolve();
         }
 
-        var jsonApiApplicationBuilder = builder.ApplicationServices.GetRequiredService<IJsonApiApplicationBuilder>();
-
-        jsonApiApplicationBuilder.ConfigureMvcOptions = options =>
-        {
-            var inputFormatter = builder.ApplicationServices.GetRequiredService<IJsonApiInputFormatter>();
-            options.InputFormatters.Insert(0, inputFormatter);
-
-            var outputFormatter = builder.ApplicationServices.GetRequiredService<IJsonApiOutputFormatter>();
-            options.OutputFormatters.Insert(0, outputFormatter);
-
-            var routingConvention = builder.ApplicationServices.GetRequiredService<IJsonApiRoutingConvention>();
-            options.Conventions.Insert(0, routingConvention);
-        };
-
         builder.UseMiddleware<JsonApiMiddleware>();
     }
 

src/JsonApiDotNetCore/Configuration/ConfigureMvcOptions.cs

@@ -0,0 +1,38 @@
+using JsonApiDotNetCore.Middleware;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+
+namespace JsonApiDotNetCore.Configuration;
+
+internal sealed class ConfigureMvcOptions : IConfigureOptions<MvcOptions>
+{
+    private readonly IJsonApiInputFormatter _inputFormatter;
+    private readonly IJsonApiOutputFormatter _outputFormatter;
+    private readonly IJsonApiRoutingConvention _routingConvention;
+
+    public ConfigureMvcOptions(IJsonApiInputFormatter inputFormatter, IJsonApiOutputFormatter outputFormatter, IJsonApiRoutingConvention routingConvention)
+    {
+        ArgumentNullException.ThrowIfNull(inputFormatter);
+        ArgumentNullException.ThrowIfNull(outputFormatter);
+        ArgumentNullException.ThrowIfNull(routingConvention);
+
+        _inputFormatter = inputFormatter;
+        _outputFormatter = outputFormatter;
+        _routingConvention = routingConvention;
+    }
+
+    public void Configure(MvcOptions options)
+    {
+        ArgumentNullException.ThrowIfNull(options);
+
+        options.EnableEndpointRouting = true;
+
+        options.InputFormatters.Insert(0, _inputFormatter);
+        options.OutputFormatters.Insert(0, _outputFormatter);
+        options.Conventions.Insert(0, _routingConvention);
+
+        options.Filters.AddService<IAsyncJsonApiExceptionFilter>();
+        options.Filters.AddService<IAsyncQueryStringActionFilter>();
+        options.Filters.AddService<IAsyncConvertEmptyActionResultFilter>();
+    }
+}

src/JsonApiDotNetCore/Configuration/IJsonApiApplicationBuilder.cs

@@ -18,22 +18,21 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
 
 namespace JsonApiDotNetCore.Configuration;
 
 /// <summary>
 /// A utility class that builds a JSON:API application. It registers all required services and allows the user to override parts of the startup
 /// configuration.
 /// </summary>
-internal sealed class JsonApiApplicationBuilder : IJsonApiApplicationBuilder
+internal sealed class JsonApiApplicationBuilder
 {
     private readonly IServiceCollection _services;
     private readonly IMvcCoreBuilder _mvcBuilder;
     private readonly JsonApiOptions _options = new();
     private readonly ResourceDescriptorAssemblyCache _assemblyCache = new();
 
-    public Action<MvcOptions>? ConfigureMvcOptions { get; set; }
-
     public JsonApiApplicationBuilder(IServiceCollection services, IMvcCoreBuilder mvcBuilder)
     {
         ArgumentNullException.ThrowIfNull(services);
@@ -105,15 +104,6 @@ public void ConfigureResourceGraph(ICollection<Type> dbContextTypes, Action<Reso
     /// </summary>
     public void ConfigureMvc()
     {
-        _mvcBuilder.AddMvcOptions(options =>
-        {
-            options.EnableEndpointRouting = true;
-            options.Filters.AddService<IAsyncJsonApiExceptionFilter>();
-            options.Filters.AddService<IAsyncQueryStringActionFilter>();
-            options.Filters.AddService<IAsyncConvertEmptyActionResultFilter>();
-            ConfigureMvcOptions?.Invoke(options);
-        });
-
         if (_options.ValidateModelState)
         {
             _mvcBuilder.AddDataAnnotations();
@@ -175,14 +165,14 @@ public void ConfigureServiceContainer(ICollection<Type> dbContextTypes)
     private void AddMiddlewareLayer()
     {
         _services.TryAddSingleton<IJsonApiOptions>(_options);
-        _services.TryAddSingleton<IJsonApiApplicationBuilder>(this);
         _services.TryAddSingleton<IExceptionHandler, ExceptionHandler>();
         _services.TryAddScoped<IAsyncJsonApiExceptionFilter, AsyncJsonApiExceptionFilter>();
         _services.TryAddScoped<IAsyncQueryStringActionFilter, AsyncQueryStringActionFilter>();
         _services.TryAddScoped<IAsyncConvertEmptyActionResultFilter, AsyncConvertEmptyActionResultFilter>();
         _services.TryAddSingleton<IJsonApiInputFormatter, JsonApiInputFormatter>();
         _services.TryAddSingleton<IJsonApiOutputFormatter, JsonApiOutputFormatter>();
         _services.TryAddSingleton<IJsonApiRoutingConvention, JsonApiRoutingConvention>();
+        _services.TryAddEnumerable(ServiceDescriptor.Singleton<IConfigureOptions<MvcOptions>, ConfigureMvcOptions>());
         _services.TryAddSingleton<IControllerResourceMapping>(provider => provider.GetRequiredService<IJsonApiRoutingConvention>());
         _services.TryAddSingleton<IJsonApiEndpointFilter, AlwaysEnabledJsonApiEndpointFilter>();
         _services.TryAddSingleton<IHttpContextAccessor, HttpContextAccessor>();