Remove the need for and use of UseApiVersioning

Chris Martinez · commonsensesoftware · commit 65e75b2d49a6 · 2017-07-03T10:13:16.000-07:00
diff --git a/ApiVersioningWithSamples.sln b/ApiVersioningWithSamples.sln
@@ -1,7 +1,7 @@
 ﻿
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 15
-VisualStudioVersion = 15.0.26430.6
+VisualStudioVersion = 15.0.26430.14
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{4D5F5F21-0CB7-4B4E-A42F-732BD4AFD0FF}"
 EndProject
@@ -74,11 +74,11 @@ Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "Test.Common", "test\Test.Co
 EndProject
 Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "Acceptance.Test.Shared", "test\Acceptance.Test.Shared\Acceptance.Test.Shared.shproj", "{6CDFB878-2642-4F98-AE35-621BAC581181}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ByNamespaceSample", "samples\aspnetcore\ByNamespaceSample\ByNamespaceSample.csproj", "{83B21A5B-0779-4391-9700-58AEFEBFA615}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ByNamespaceSample", "samples\aspnetcore\ByNamespaceSample\ByNamespaceSample.csproj", "{83B21A5B-0779-4391-9700-58AEFEBFA615}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.AspNet.WebApi.Versioning.ApiExplorer", "src\Microsoft.AspNet.WebApi.Versioning.ApiExplorer\Microsoft.AspNet.WebApi.Versioning.ApiExplorer.csproj", "{91E1F0B5-905D-446C-A2DD-4C1EDABFAF6C}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.AspNet.WebApi.Versioning.ApiExplorer", "src\Microsoft.AspNet.WebApi.Versioning.ApiExplorer\Microsoft.AspNet.WebApi.Versioning.ApiExplorer.csproj", "{91E1F0B5-905D-446C-A2DD-4C1EDABFAF6C}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.AspNet.WebApi.Versioning.ApiExplorer.Tests", "test\Microsoft.AspNet.WebApi.Versioning.ApiExplorer.Tests\Microsoft.AspNet.WebApi.Versioning.ApiExplorer.Tests.csproj", "{19A2C130-46B4-4CA3-B655-B7547BC414AC}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.AspNet.WebApi.Versioning.ApiExplorer.Tests", "test\Microsoft.AspNet.WebApi.Versioning.ApiExplorer.Tests\Microsoft.AspNet.WebApi.Versioning.ApiExplorer.Tests.csproj", "{19A2C130-46B4-4CA3-B655-B7547BC414AC}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer", "src\Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer\Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer.csproj", "{F7784C3A-5569-4590-AE28-B721C0426045}"
 EndProject
@@ -90,9 +90,9 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SwaggerWebApiSample", "samp
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SwaggerODataWebApiSample", "samples\webapi\SwaggerODataWebApiSample\SwaggerODataWebApiSample.csproj", "{F3986F7B-AF76-43D1-A44F-303023A08CD3}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.AspNet.OData.Versioning.ApiExplorer", "src\Microsoft.AspNet.OData.Versioning.ApiExplorer\Microsoft.AspNet.OData.Versioning.ApiExplorer.csproj", "{1B255310-A2B7-437F-804F-6E1D8C940A17}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.AspNet.OData.Versioning.ApiExplorer", "src\Microsoft.AspNet.OData.Versioning.ApiExplorer\Microsoft.AspNet.OData.Versioning.ApiExplorer.csproj", "{1B255310-A2B7-437F-804F-6E1D8C940A17}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.AspNet.OData.Versioning.ApiExplorer.Tests", "test\Microsoft.AspNet.OData.Versioning.ApiExplorer.Tests\Microsoft.AspNet.OData.Versioning.ApiExplorer.Tests.csproj", "{3B7E0FEF-8019-4A17-A55F-A6FA378DA856}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.AspNet.OData.Versioning.ApiExplorer.Tests", "test\Microsoft.AspNet.OData.Versioning.ApiExplorer.Tests\Microsoft.AspNet.OData.Versioning.ApiExplorer.Tests.csproj", "{3B7E0FEF-8019-4A17-A55F-A6FA378DA856}"
 EndProject
 Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "Common.ApiExplorer", "src\Common.ApiExplorer\Common.ApiExplorer.shproj", "{26A67334-F6E6-49B8-8C5A-F88F28770966}"
 EndProject
diff --git a/samples/aspnetcore/BasicSample/Startup.cs b/samples/aspnetcore/BasicSample/Startup.cs
@@ -39,7 +39,6 @@ public void Configure( IApplicationBuilder app, IHostingEnvironment env, ILogger
             loggerFactory.AddConsole( Configuration.GetSection( "Logging" ) );
             loggerFactory.AddDebug();
             app.UseMvc();
-            app.UseApiVersioning();
         }
     }
 }
diff --git a/samples/aspnetcore/ByNamespaceSample/Startup.cs b/samples/aspnetcore/ByNamespaceSample/Startup.cs
@@ -28,7 +28,6 @@ public void Configure( IApplicationBuilder app, IHostingEnvironment env, ILogger
             }
 
             app.UseMvc();
-            app.UseApiVersioning();
         }
     }
 }
diff --git a/samples/aspnetcore/ConventionsSample/Startup.cs b/samples/aspnetcore/ConventionsSample/Startup.cs
@@ -54,7 +54,6 @@ public void Configure( IApplicationBuilder app, IHostingEnvironment env, ILogger
             loggerFactory.AddConsole( Configuration.GetSection( "Logging" ) );
             loggerFactory.AddDebug();
             app.UseMvc();
-            app.UseApiVersioning();
         }
     }
 }
diff --git a/samples/aspnetcore/SwaggerSample/Startup.cs b/samples/aspnetcore/SwaggerSample/Startup.cs
@@ -84,7 +84,6 @@ public void Configure( IApplicationBuilder app, IHostingEnvironment env, ILogger
             loggerFactory.AddDebug();
 
             app.UseMvc();
-            app.UseApiVersioning();
             app.UseSwagger();
             app.UseSwaggerUI(
                 options =>
diff --git a/src/Microsoft.AspNetCore.Mvc.Versioning/Microsoft.Extensions.DependencyInjection/IApplicationBuilderExtensions.cs b/src/Microsoft.AspNetCore.Mvc.Versioning/Microsoft.Extensions.DependencyInjection/IApplicationBuilderExtensions.cs
diff --git a/src/Microsoft.AspNetCore.Mvc.Versioning/Microsoft.Extensions.DependencyInjection/IServiceCollectionExtensions.cs b/src/Microsoft.AspNetCore.Mvc.Versioning/Microsoft.Extensions.DependencyInjection/IServiceCollectionExtensions.cs
@@ -5,6 +5,8 @@
     using AspNetCore.Mvc.Routing;
     using AspNetCore.Mvc.Versioning;
     using Extensions;
+    using Microsoft.AspNetCore.Builder;
+    using Microsoft.AspNetCore.Hosting;
     using Options;
     using System;
     using System.Diagnostics.Contracts;
@@ -43,26 +45,38 @@ public static IServiceCollection AddApiVersioning( this IServiceCollection servi
             services.Add( Singleton<IOptions<ApiVersioningOptions>>( new OptionsWrapper<ApiVersioningOptions>( options ) ) );
             services.Replace( Singleton<IActionSelector, ApiVersionActionSelector>() );
             services.TryAddSingleton<IApiVersionRoutePolicy, DefaultApiVersionRoutePolicy>();
+            services.AddTransient<IStartupFilter, InjectApiVersionRoutePolicy>();
+            services.AddMvcCore( mvcOptions => AddMvcOptions( mvcOptions, options ) );
+            services.AddRouting( routeOptions => routeOptions.ConstraintMap.Add( "apiVersion", typeof( ApiVersionRouteConstraint ) ) );
+
+            return services;
+        }
+
+        static void AddMvcOptions( MvcOptions mvcOptions, ApiVersioningOptions options )
+        {
+            Contract.Requires( mvcOptions != null );
+            Contract.Requires( options != null );
 
             if ( options.ReportApiVersions )
             {
-                services.AddSingleton<ReportApiVersionsAttribute>();
+                mvcOptions.Filters.Add( new ReportApiVersionsAttribute() );
             }
 
-            services.AddMvcCore(
-                mvcOptions =>
-                {
-                    if ( options.ReportApiVersions )
-                    {
-                        mvcOptions.Filters.Add( typeof( ReportApiVersionsAttribute ) );
-                    }
-
-                    mvcOptions.Conventions.Add( new ApiVersionConvention( options.DefaultApiVersion, options.Conventions ) );
-                } );
+            mvcOptions.Conventions.Add( new ApiVersionConvention( options.DefaultApiVersion, options.Conventions ) );
+        }
 
-            services.AddRouting( routeOptions => routeOptions.ConstraintMap.Add( "apiVersion", typeof( ApiVersionRouteConstraint ) ) );
+        sealed class InjectApiVersionRoutePolicy : IStartupFilter
+        {
+            public Action<IApplicationBuilder> Configure( Action<IApplicationBuilder> next )
+            {
+                Contract.Requires( next != null );
 
-            return services;
+                return app =>
+                {
+                    next( app );
+                    app.UseRouter( builder => builder.Routes.Add( builder.ServiceProvider.GetRequiredService<IApiVersionRoutePolicy>() ) );
+                };
+            }
         }
     }
 }
diff --git a/test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/AcceptanceTest.cs b/test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/AcceptanceTest.cs
@@ -66,7 +66,7 @@ protected virtual void Dispose( bool disposing )
         TestServer CreateServer()
         {
             var builder = new WebHostBuilder()
-                .Configure( app => app.UseMvc( OnConfigureRoutes ).UseMvcWithDefaultRoute().UseApiVersioning() )
+                .Configure( app => app.UseMvc( OnConfigureRoutes ).UseMvcWithDefaultRoute() )
                 .ConfigureServices( OnConfigureServices )
                 .UseContentRoot( GetContentRoot() );
 
diff --git a/test/Microsoft.AspNetCore.Mvc.Versioning.Tests/Microsoft.Extensions.DependencyInjection/IServiceCollectionExtensionsTest.cs b/test/Microsoft.AspNetCore.Mvc.Versioning.Tests/Microsoft.Extensions.DependencyInjection/IServiceCollectionExtensionsTest.cs
@@ -69,8 +69,7 @@ public void add_api_versioning_should_configure_mvc_with_custom_options()
             services.Single( sd => sd.ServiceType == typeof( IApiVersionReader ) ).ImplementationInstance.Should().NotBeNull();
             services.Single( sd => sd.ServiceType == typeof( IApiVersionSelector ) ).ImplementationInstance.Should().BeOfType<ConstantApiVersionSelector>();
             services.Single( sd => sd.ServiceType == typeof( IActionSelector ) ).ImplementationType.Should().Be( typeof( ApiVersionActionSelector ) );
-            services.Single( sd => sd.ServiceType == typeof( ReportApiVersionsAttribute ) ).ImplementationType.Should().Be( typeof( ReportApiVersionsAttribute ) );
-            mvcOptions.Filters.OfType<TypeFilterAttribute>().Single().ImplementationType.Should().Be( typeof( ReportApiVersionsAttribute ) );
+            mvcOptions.Filters.Single().Should().BeOfType<ReportApiVersionsAttribute>();
             mvcOptions.Conventions.Single().Should().BeOfType<ApiVersionConvention>();
             routeOptions.ConstraintMap["apiVersion"].Should().Be( typeof( ApiVersionRouteConstraint ) );
         }
diff --git a/test/Microsoft.AspNetCore.Mvc.Versioning.Tests/Versioning/WebServer.cs b/test/Microsoft.AspNetCore.Mvc.Versioning.Tests/Versioning/WebServer.cs
@@ -31,7 +31,7 @@ public WebServer( Action<ApiVersioningOptions> setupApiVersioning = null, Action
             }
 
             var hostBuilder = new WebHostBuilder()
-                .Configure( app => app.UseMvc( setupRoutes ).UseApiVersioning() )
+                .Configure( app => app.UseMvc( setupRoutes ) )
                 .ConfigureServices(
                     services =>
                     {

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,6 @@ public void Configure( IApplicationBuilder app, IHostingEnvironment env, ILogger`
`39`	`39`	`loggerFactory.AddConsole( Configuration.GetSection( "Logging" ) );`
`40`	`40`	`loggerFactory.AddDebug();`
`41`	`41`	`app.UseMvc();`
`42`		`- app.UseApiVersioning();`
`43`	`42`	`}`
`44`	`43`	`}`
`45`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,6 @@ public void Configure( IApplicationBuilder app, IHostingEnvironment env, ILogger`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`app.UseMvc();`
`31`		`- app.UseApiVersioning();`
`32`	`31`	`}`
`33`	`32`	`}`
`34`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,6 @@ public void Configure( IApplicationBuilder app, IHostingEnvironment env, ILogger`
`54`	`54`	`loggerFactory.AddConsole( Configuration.GetSection( "Logging" ) );`
`55`	`55`	`loggerFactory.AddDebug();`
`56`	`56`	`app.UseMvc();`
`57`		`- app.UseApiVersioning();`
`58`	`57`	`}`
`59`	`58`	`}`
`60`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ protected virtual void Dispose( bool disposing )`
`66`	`66`	`TestServer CreateServer()`
`67`	`67`	`{`
`68`	`68`	`var builder = new WebHostBuilder()`
`69`		`- .Configure( app => app.UseMvc( OnConfigureRoutes ).UseMvcWithDefaultRoute().UseApiVersioning() )`
	`69`	`+ .Configure( app => app.UseMvc( OnConfigureRoutes ).UseMvcWithDefaultRoute() )`
`70`	`70`	`.ConfigureServices( OnConfigureServices )`
`71`	`71`	`.UseContentRoot( GetContentRoot() );`
`72`	`72`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public WebServer( Action<ApiVersioningOptions> setupApiVersioning = null, Action`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`var hostBuilder = new WebHostBuilder()`
`34`		`- .Configure( app => app.UseMvc( setupRoutes ).UseApiVersioning() )`
	`34`	`+ .Configure( app => app.UseMvc( setupRoutes ) )`
`35`	`35`	`.ConfigureServices(`
`36`	`36`	`services =>`
`37`	`37`	`{`