Update 405 handling for API version-neutral routes. Fixes #159

Author: Chris Martinez

src/Microsoft.AspNetCore.Mvc.Versioning/Microsoft.AspNetCore.Mvc.Versioning.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
-  <VersionPrefix>1.2.0</VersionPrefix>
+  <VersionPrefix>1.2.1</VersionPrefix>
   <AssemblyVersion>1.2.0.0</AssemblyVersion>
   <TargetFrameworks>net451;netstandard1.6</TargetFrameworks>
   <NetStandardImplicitPackageVersion>1.6.1</NetStandardImplicitPackageVersion>
@@ -11,7 +11,7 @@
   <Description>A service API versioning library for Microsoft ASP.NET Core.</Description>
   <RootNamespace>Microsoft.AspNetCore.Mvc</RootNamespace>
   <PackageTags>Microsoft;AspNet;AspNetCore;Versioning</PackageTags>
-  <PackageReleaseNotes>• Remove need for UseApiVersioning (Issue #152)</PackageReleaseNotes>
+  <PackageReleaseNotes>• Fix 405 for API version-neutral routes (Issue #159)</PackageReleaseNotes>
  </PropertyGroup>
 
  <ItemGroup>

src/Microsoft.AspNetCore.Mvc.Versioning/Routing/DefaultApiVersionRoutePolicy.cs

@@ -190,6 +190,7 @@ RequestHandler ClientError( RouteContext context, ActionSelectionResult selectio
             var httpContext = context.HttpContext;
             var properties = httpContext.ApiVersionProperties();
             var code = default( string );
+            var message = default( string );
             var requestedVersion = default( string );
             var parsedVersion = properties.ApiVersion;
             var actionNames = new Lazy<string>( () => Join( NewLine, candidates.Select( a => a.DisplayName ) ) );
@@ -198,9 +199,11 @@ RequestHandler ClientError( RouteContext context, ActionSelectionResult selectio
 
             if ( parsedVersion == null )
             {
+                var versionNeutral = new Lazy<bool>( () => candidates.Any( c => c.IsApiVersionNeutral() ) );
+
                 requestedVersion = properties.RawApiVersion;
 
-                if ( IsNullOrEmpty( requestedVersion ) )
+                if ( IsNullOrEmpty( requestedVersion ) && !versionNeutral.Value )
                 {
                     code = ApiVersionUnspecified;
                     Logger.ApiVersionUnspecified( actionNames.Value );
@@ -220,6 +223,18 @@ RequestHandler ClientError( RouteContext context, ActionSelectionResult selectio
                         newRequestHandler = ( e, c, m ) => new MethodNotAllowedHandler( e, c, m, allowedMethods.Value.ToArray() );
                     }
                 }
+                else if ( versionNeutral.Value )
+                {
+                    Logger.ApiVersionUnspecified( actionNames.Value );
+                    message = SR.VersionNeutralResourceNotSupported.FormatDefault( httpContext.Request.GetDisplayUrl() );
+
+                    if ( allowedMethods.Value.Contains( httpContext.Request.Method ) )
+                    {
+                        return new BadRequestHandler( ErrorResponseProvider, UnsupportedApiVersion, message );
+                    }
+
+                    return new MethodNotAllowedHandler( ErrorResponseProvider, UnsupportedApiVersion, message, allowedMethods.Value.ToArray() );
+                }
                 else
                 {
                     code = InvalidApiVersion;
@@ -243,7 +258,7 @@ RequestHandler ClientError( RouteContext context, ActionSelectionResult selectio
                 }
             }
 
-            var message = SR.VersionedResourceNotSupported.FormatDefault( httpContext.Request.GetDisplayUrl(), requestedVersion );
+            message = SR.VersionedResourceNotSupported.FormatDefault( httpContext.Request.GetDisplayUrl(), requestedVersion );
             return newRequestHandler( ErrorResponseProvider, code, message );
         }
 

src/Microsoft.AspNetCore.Mvc.Versioning/SR.Designer.cs

@@ -154,6 +154,9 @@
   <data name="VersionedResourceNotSupported" xml:space="preserve">
     <value>The HTTP resource that matches the request URI '{0}' does not support the API version '{1}'.</value>
   </data>
+  <data name="VersionNeutralResourceNotSupported" xml:space="preserve">
+    <value>The HTTP resource that matches the request URI '{0}' is not supported.</value>
+  </data>
   <data name="ZeroApiVersionReaders" xml:space="preserve">
     <value>At least one IApiVersionReader must be specified.</value>
   </data>

src/Microsoft.AspNetCore.Mvc.Versioning/SR.resx

@@ -1,7 +1,9 @@
 namespace given_a_version_neutral_ApiController
 {
     using FluentAssertions;
+    using Microsoft.Web;
     using Microsoft.Web.Http.Basic;
+    using System.Net.Http;
     using System.Threading.Tasks;
     using Xunit;
     using static System.Net.HttpStatusCode;
@@ -20,5 +22,31 @@ public async Task then_get_should_return_204()
             // assert
             response.StatusCode.Should().Be( NoContent );
         }
+
+        [Fact]
+        public async Task then_post_should_return_405()
+        {
+            // arrange
+            var entity = new { };
+
+            // act
+            var response = await PostAsync( "api/ping", entity );
+            var content = await response.Content.ReadAsAsync<OneApiErrorResponse>();
+
+            // assert
+            response.StatusCode.Should().Be( MethodNotAllowed );
+            response.Content.Headers.Allow.Should().BeEquivalentTo( "GET" );
+            content.Error.ShouldBeEquivalentTo(
+                new
+                {
+                    Code = "UnsupportedApiVersion",
+                    InnerError = new
+                    {
+                        Code = default( string ),
+                        Message = "No route providing a controller name with API version '(null)' was found to match request URI 'http://localhost/api/ping'."
+                    },
+                    Message = "The HTTP resource that matches the request URI 'http://localhost/api/ping' does not support the API version '(null)'."
+                } );
+        }
     }
 }

test/Microsoft.AspNet.WebApi.Acceptance.Tests/Http/Basic/given a version-neutral ApiController/when no version is specified.cs

@@ -1,7 +1,9 @@
 namespace given_a_versionX2Dneutral_Controller
 {
     using FluentAssertions;
+    using Microsoft.AspNetCore.Mvc;
     using Microsoft.AspNetCore.Mvc.Basic;
+    using System.Net.Http;
     using System.Threading.Tasks;
     using Xunit;
     using static System.Net.HttpStatusCode;
@@ -20,5 +22,27 @@ public async Task then_get_should_return_204()
             // assert
             response.StatusCode.Should().Be( NoContent );
         }
+
+        [Fact]
+        public async Task then_post_should_return_405()
+        {
+            // arrange
+            var entity = new { };
+
+            // act
+            var response = await PostAsync( "api/ping", entity );
+            var content = await response.Content.ReadAsAsync<OneApiErrorResponse>();
+
+            // assert
+            response.StatusCode.Should().Be( MethodNotAllowed );
+            response.Content.Headers.Allow.Should().BeEquivalentTo( "GET" );
+            content.Error.ShouldBeEquivalentTo(
+                new
+                {
+                    Code = "UnsupportedApiVersion",
+                    InnerError = default( OneApiInnerError ),
+                    Message = "The HTTP resource that matches the request URI 'http://localhost/api/ping' is not supported."
+                } );
+        }
     }
 }