Refactor to use API behaviors everywhere

Author: Chris Martinez

src/Microsoft.AspNetCore.Mvc.Versioning/Versioning/ApiVersioningApplicationModelProvider.cs

@@ -17,6 +17,7 @@
     public class ApiVersioningApplicationModelProvider : IApplicationModelProvider
     {
         readonly IOptions<ApiVersioningOptions> options;
+        readonly Lazy<Func<ControllerModel, bool>> isApiController = new Lazy<Func<ControllerModel, bool>>( NewIsApiControllerFunc );
 
         /// <summary>
         /// Initializes a new instance of the <see cref="ApiVersioningApplicationModelProvider"/> class.
@@ -45,7 +46,12 @@ public virtual void OnProvidersExecuted( ApplicationModelProviderContext context
             var implicitVersionModel = new ApiVersionModel( Options.DefaultApiVersion );
             var conventionBuilder = Options.Conventions;
             var application = context.Result;
-            var controllers = FilterControllers( application.Controllers );
+            IEnumerable<ControllerModel> controllers = application.Controllers;
+
+            if ( Options.UseApiBehavior )
+            {
+                controllers = controllers.Where( isApiController.Value );
+            }
 
             foreach ( var controller in controllers )
             {
@@ -59,37 +65,6 @@ public virtual void OnProvidersExecuted( ApplicationModelProviderContext context
         /// <inheritdoc />
         public virtual void OnProvidersExecuting( ApplicationModelProviderContext context ) { }
 
-        IEnumerable<ControllerModel> FilterControllers( IEnumerable<ControllerModel> controllers )
-        {
-            Contract.Requires( controllers != null );
-            Contract.Ensures( Contract.Result<IEnumerable<ControllerModel>>() != null );
-
-            if ( !Options.UseApiBehavior )
-            {
-                return controllers;
-            }
-
-            var assembly = typeof( ControllerAttribute ).Assembly;
-            var apiBehaviorSupported = assembly.ExportedTypes.Any( t => t.Name == "ApiControllerAttribute" );
-
-            return apiBehaviorSupported ? controllers.Where( IsApiController ) : controllers;
-        }
-
-        static bool IsApiController( ControllerModel controller )
-        {
-            if ( controller.Attributes.Any( IsApiBehaviorMetadata ) )
-            {
-                return true;
-            }
-
-            var controllerAssembly = controller.ControllerType.Assembly;
-            var assemblyAttributes = controllerAssembly.GetCustomAttributes();
-
-            return assemblyAttributes.Any( IsApiBehaviorMetadata );
-        }
-
-        static bool IsApiBehaviorMetadata( object attribute ) => attribute.GetType().GetInterfaces().Any( i => i.Name == "IApiBehaviorMetadata" );
-
         static bool IsDecoratedWithAttributes( ControllerModel controller )
         {
             Contract.Requires( controller != null );
@@ -131,5 +106,12 @@ static void ApplyAttributeOrImplicitConventions( ControllerModel controller, Api
                 ApplyImplicitConventions( controller, implicitVersionModel );
             }
         }
+
+        static Func<ControllerModel, bool> NewIsApiControllerFunc()
+        {
+            var type = Type.GetType( "Microsoft.AspNetCore.Mvc.ApplicationModels.ApiBehaviorApplicationModelProvider, Microsoft.AspNetCore.Mvc.Core", throwOnError: true );
+            var method = type.GetRuntimeMethods().Single( m => m.Name == "IsApiController" );
+            return (Func<ControllerModel, bool>) method.CreateDelegate( typeof( Func<ControllerModel, bool> ) );
+        }
     }
 }

src/Microsoft.AspNetCore.Mvc.Versioning/Versioning/ApiVersioningOptions.cs

@@ -21,11 +21,10 @@ public partial class ApiVersioningOptions
         /// <summary>
         /// Gets or sets a value indicating whether to use web API behaviors.
         /// </summary>
-        /// <value>True to use web API behaviors; otherwise, false. The default value is <c>false</c>.</value>
-        /// <remarks>Setting this property to <c>true</c> applies API versioning policies only to controllers that
-        /// have the ApiControllerAttribute applied. A value of <c>true</c> is only effective when using ASP.NET Core
-        /// 2.1 or above. The default value of <c>false</c> retains backward capability with the existing behaviors
-        /// before the API behavior feature was introduced.</remarks>
-        public bool UseApiBehavior { get; set; }
+        /// <value>True to use web API behaviors; otherwise, false. The default value is <c>true</c>.</value>
+        /// <remarks>When this property is set to <c>true</c>, API versioning policies only apply to controllers that
+        /// have the ApiControllerAttribute applied. When this property is set to <c>false</c>, API versioning
+        /// policies are considers for all controllers. This was default behavior prior to ASP.NET Core 2.2.</remarks>
+        public bool UseApiBehavior { get; set; } = true;
     }
 }

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/Basic/Controllers/HelloWorld2Controller.cs

@@ -4,9 +4,10 @@
     using Microsoft.AspNetCore.Mvc;
     using System;
 
+    [ApiController]
     [ApiVersion( "2.0" )]
     [Route( "api/v{version:apiVersion}/HelloWorld" )]
-    public class HelloWorld2Controller : Controller
+    public class HelloWorld2Controller : ControllerBase
     {
         [HttpGet]
         public IActionResult Get() => Ok( new { Controller = GetType().Name, Version = HttpContext.GetRequestedApiVersion().ToString() } );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/Basic/Controllers/HelloWorldController.cs

@@ -4,9 +4,10 @@
     using Microsoft.AspNetCore.Mvc;
     using System;
 
+    [ApiController]
     [ApiVersion( "1.0" )]
     [Route( "api/v{version:apiVersion}/[controller]" )]
-    public class HelloWorldController : Controller
+    public class HelloWorldController : ControllerBase
     {
         [HttpGet]
         public IActionResult Get() => Ok( new { Controller = GetType().Name, Version = HttpContext.GetRequestedApiVersion().ToString() } );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/Basic/Controllers/OrdersController.cs

@@ -3,6 +3,7 @@
     using Microsoft.AspNetCore.Mvc;
     using System;
 
+    [ApiController]
     [Route( "api/[controller]" )]
     public class OrdersController : ControllerBase
     {

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/Basic/Controllers/OverlappingRouteTemplateController.cs

@@ -3,9 +3,10 @@
     using Microsoft.AspNetCore.Mvc;
     using System;
 
+    [ApiController]
     [ApiVersion( "1.0" )]
     [Route( "api/v{version:apiVersion}/values" )]
-    public class OverlappingRouteTemplateController : Controller
+    public class OverlappingRouteTemplateController : ControllerBase
     {
         [HttpGet( "{id:int}/{childId}" )]
         public IActionResult Get( int id, string childId ) => Ok( new { id, childId } );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/Basic/Controllers/PingController.cs

@@ -2,9 +2,10 @@
 {
     using System;
 
+    [ApiController]
     [ApiVersionNeutral]
     [Route( "api/[controller]" )]
-    public class PingController : Controller
+    public class PingController : ControllerBase
     {
         [HttpGet]
         public IActionResult Get() => NoContent();

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/Basic/Controllers/Values2Controller.cs

@@ -3,9 +3,10 @@
     using Microsoft.AspNetCore.Mvc;
     using System;
 
+    [ApiController]
     [ApiVersion( "2.0" )]
     [Route( "api/values" )]
-    public class Values2Controller : Controller
+    public class Values2Controller : ControllerBase
     {
         [HttpGet]
         public IActionResult Get() => Ok( new { Controller = nameof( Values2Controller ), Version = HttpContext.GetRequestedApiVersion().ToString() } );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/Basic/Controllers/ValuesController.cs

@@ -3,9 +3,10 @@
     using Microsoft.AspNetCore.Mvc;
     using System;
 
+    [ApiController]
     [ApiVersion( "1.0" )]
     [Route( "api/[controller]" )]
-    public class ValuesController : Controller
+    public class ValuesController : ControllerBase
     {
         [HttpGet]
         public IActionResult Get() => Ok( new { Controller = nameof( ValuesController ), Version = HttpContext.GetRequestedApiVersion().ToString() } );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/Basic/Controllers/WithViewsUsingAttributes/HomeController.cs

@@ -2,7 +2,6 @@
 {
     using System;
 
-    [ApiVersionNeutral]
     [Route( "" )]
     [Route( "[controller]" )]
     public class HomeController : Controller

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/Basic/Controllers/WithViewsUsingConventions/HomeController.cs

@@ -2,7 +2,6 @@
 {
     using System;
 
-    [ApiVersionNeutral]
     public class HomeController : Controller
     {
         public IActionResult Index() => View();

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/ByNamespace/Controllers/V1/AgreementsController.cs

@@ -2,7 +2,8 @@
 {
     using Models;
 
-    public class AgreementsController : Controller
+    [ApiController]
+    public class AgreementsController : ControllerBase
     {
         [HttpGet]
         public IActionResult Get( string accountId, ApiVersion apiVersion ) => Ok( new Agreement( GetType().FullName, accountId, apiVersion.ToString() ) );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/ByNamespace/Controllers/V2/AgreementsController.cs

@@ -2,7 +2,8 @@
 {
     using Models;
 
-    public class AgreementsController : Controller
+    [ApiController]
+    public class AgreementsController : ControllerBase
     {
         [HttpGet]
         public IActionResult Get( string accountId, ApiVersion apiVersion ) => Ok( new Agreement( GetType().FullName, accountId, apiVersion.ToString() ) );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/ByNamespace/Controllers/V3/AgreementsController.cs

@@ -2,7 +2,8 @@
 {
     using Models;
 
-    public class AgreementsController : Controller
+    [ApiController]
+    public class AgreementsController : ControllerBase
     {
         [HttpGet]
         public IActionResult Get( string accountId, ApiVersion apiVersion ) => Ok( new Agreement( GetType().FullName, accountId, apiVersion.ToString() ) );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/Conventions/Controllers/HelloWorld2Controller.cs

@@ -4,8 +4,9 @@
     using Microsoft.AspNetCore.Mvc;
     using System;
 
+    [ApiController]
     [Route( "api/v{version:apiVersion}/helloworld" )]
-    public class HelloWorld2Controller : Controller
+    public class HelloWorld2Controller : ControllerBase
     {
         [HttpGet]
         public IActionResult Get() => Ok( new { Controller = nameof( HelloWorld2Controller ), Version = HttpContext.GetRequestedApiVersion().ToString() } );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/Conventions/Controllers/HelloWorldController.cs

@@ -4,8 +4,9 @@
     using Microsoft.AspNetCore.Mvc;
     using System;
 
+    [ApiController]
     [Route( "api/v{version:apiVersion}/[controller]" )]
-    public class HelloWorldController : Controller
+    public class HelloWorldController : ControllerBase
     {
         [HttpGet]
         public IActionResult Get() => Ok( new { Controller = nameof( HelloWorldController ), Version = HttpContext.GetRequestedApiVersion().ToString() } );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/Conventions/Controllers/Values2Controller.cs

@@ -4,7 +4,7 @@
     using System;
 
     [Route( "api/values" )]
-    public class Values2Controller : Controller
+    public class Values2Controller : ControllerBase
     {
         [HttpGet]
         public IActionResult Get() => Ok( new { Controller = nameof( Values2Controller ), Version = HttpContext.GetRequestedApiVersion().ToString() } );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/Conventions/Controllers/ValuesController.cs

@@ -4,7 +4,7 @@
     using System;
 
     [Route( "api/[controller]" )]
-    public class ValuesController : Controller
+    public class ValuesController : ControllerBase
     {
         [HttpGet]
         public IActionResult Get() => Ok( new { Controller = nameof( ValuesController ), Version = HttpContext.GetRequestedApiVersion().ToString() } );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/MediaTypeNegotiation/Controllers/HelloWorldController.cs

@@ -7,7 +7,7 @@
     using System.Collections.Generic;
 
     [Route( "api/[controller]" )]
-    public class HelloWorldController : Controller
+    public class HelloWorldController : ControllerBase
     {
         [HttpGet]
         public IActionResult Get() => Ok( new { Controller = nameof( HelloWorldController ), Version = HttpContext.GetRequestedApiVersion().ToString() } );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/MediaTypeNegotiation/Controllers/Values2Controller.cs

@@ -5,7 +5,7 @@
 
     [ApiVersion( "2.0" )]
     [Route( "api/values" )]
-    public class Values2Controller : Controller
+    public class Values2Controller : ControllerBase
     {
         [HttpGet]
         public IActionResult Get() => Ok( new { Controller = nameof( Values2Controller ), Version = HttpContext.GetRequestedApiVersion().ToString() } );

test/Microsoft.AspNetCore.Mvc.Acceptance.Tests/Mvc/MediaTypeNegotiation/Controllers/ValuesController.cs

@@ -5,7 +5,7 @@
 
     [ApiVersion( "1.0" )]
     [Route( "api/[controller]" )]
-    public class ValuesController : Controller
+    public class ValuesController : ControllerBase
     {
         [HttpGet]
         public IActionResult Get() => Ok( new { Controller = nameof( ValuesController ), Version = HttpContext.GetRequestedApiVersion().ToString() } );

test/Microsoft.AspNetCore.Mvc.Versioning.Tests/Simulators/AmbiguousController.cs

@@ -3,8 +3,9 @@
     using System;
     using System.Threading.Tasks;
 
+    [ApiController]
     [ApiVersion( "1.0" )]
-    public sealed class AmbiguousController : Controller
+    public sealed class AmbiguousController : ControllerBase
     {
         [HttpGet]
         public Task<string> Get() => Task.FromResult( "Test" );

test/Microsoft.AspNetCore.Mvc.Versioning.Tests/Simulators/AmbiguousNeutralController.cs

@@ -3,9 +3,10 @@
     using System;
     using System.Threading.Tasks;
 
+    [ApiController]
     [ApiVersionNeutral]
     [ControllerName( "Ambiguous" )]
-    public sealed class AmbiguousNeutralController : Controller
+    public sealed class AmbiguousNeutralController : ControllerBase
     {
         [HttpGet]
         public Task<string> Get() => Task.FromResult( "Test" );

test/Microsoft.AspNetCore.Mvc.Versioning.Tests/Simulators/AmbiguousToo2Controller.cs

@@ -3,9 +3,10 @@
     using System;
     using System.Threading.Tasks;
 
+    [ApiController]
     [ApiVersion( "1.0" )]
     [ControllerName( "AmbiguousToo" )]
-    public sealed class AmbiguousToo2Controller : Controller
+    public sealed class AmbiguousToo2Controller : ControllerBase
     {
         [HttpGet]
         public Task<string> Get() => Task.FromResult( "Test" );

test/Microsoft.AspNetCore.Mvc.Versioning.Tests/Simulators/AmbiguousTooController.cs

@@ -3,8 +3,9 @@
     using System;
     using System.Threading.Tasks;
 
+    [ApiController]
     [ApiVersion( "1.0" )]
-    public sealed class AmbiguousTooController : Controller
+    public sealed class AmbiguousTooController : ControllerBase
     {
         [HttpGet]
         public Task<string> Get() => Task.FromResult( "Test" );

test/Microsoft.AspNetCore.Mvc.Versioning.Tests/Simulators/ApiVersionedRoute2Controller.cs

@@ -3,10 +3,11 @@
     using System;
     using System.Threading.Tasks;
 
+    [ApiController]
     [ApiVersion( "5.0" )]
     [ApiVersion( "4.0", Deprecated = true )]
     [Route( "api/v{version:apiVersion}/attributed" )]
-    public sealed class ApiVersionedRoute2Controller : Controller
+    public sealed class ApiVersionedRoute2Controller : ControllerBase
     {
         [HttpGet]
         [MapToApiVersion( "4.0" )]

test/Microsoft.AspNetCore.Mvc.Versioning.Tests/Simulators/ApiVersionedRouteController.cs

@@ -3,11 +3,12 @@
     using System;
     using System.Threading.Tasks;
 
+    [ApiController]
     [ApiVersion( "1.0" )]
     [ApiVersion( "2.0" )]
     [ApiVersion( "3.0" )]
     [Route( "api/v{version:apiVersion}/attributed" )]
-    public sealed class ApiVersionedRouteController : Controller
+    public sealed class ApiVersionedRouteController : ControllerBase
     {
         [HttpGet]
         public Task<string> Get() => Task.FromResult( "Test" );

test/Microsoft.AspNetCore.Mvc.Versioning.Tests/Simulators/AttributeRoutedAmbiguous2Controller.cs

@@ -3,9 +3,10 @@
     using System;
     using System.Threading.Tasks;
 
+    [ApiController]
     [ApiVersion( "1.0" )]
     [Route( "api/attributed/ambiguous" )]
-    public sealed class AttributeRoutedAmbiguous2Controller : Controller
+    public sealed class AttributeRoutedAmbiguous2Controller : ControllerBase
     {
         [HttpGet]
         public Task<string> Get() => Task.FromResult( "Test" );

test/Microsoft.AspNetCore.Mvc.Versioning.Tests/Simulators/AttributeRoutedAmbiguous3Controller.cs

@@ -3,9 +3,10 @@
     using System;
     using System.Threading.Tasks;
 
+    [ApiController]
     [ApiVersion( "1.0" )]
     [Route( "api/attributed/ambiguous" )]
-    public sealed class AttributeRoutedAmbiguous3Controller : Controller
+    public sealed class AttributeRoutedAmbiguous3Controller : ControllerBase
     {
         [HttpGet]
         public Task<string> Get() => Task.FromResult( "Test" );

test/Microsoft.AspNetCore.Mvc.Versioning.Tests/Simulators/AttributeRoutedAmbiguousController.cs

@@ -3,9 +3,10 @@
     using System;
     using System.Threading.Tasks;
 
+    [ApiController]
     [ApiVersion( "1.0" )]
     [Route( "api/attributed-ambiguous" )]
-    public sealed class AttributeRoutedAmbiguousController : Controller
+    public sealed class AttributeRoutedAmbiguousController : ControllerBase
     {
         [HttpGet]
         public Task<string> Get() => Task.FromResult( "Test" );