Updates responses to return 400 instead of 404 when a required version for a valid resource is not specified. Resolves #61 and fixes #62. (#63)

Author: commonsensesoftware

ApiVersioning.sln

@@ -19,6 +19,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 	ProjectSection(SolutionItems) = preProject
 		.gitattributes = .gitattributes
 		.gitignore = .gitignore
+		appveyor.yml = appveyor.yml
+		global.json = global.json
 		LICENSE = LICENSE
 		pack.ps1 = pack.ps1
 		README.md = README.md

global.json

@@ -1,3 +1,4 @@
 {
-    "projects": [ "src", "test" ]
+    "projects": [ "src", "test" ],
+    "sdk": { "version": "1.0.0-preview2-003121" }
 }

src/Microsoft.AspNet.OData.Versioning/project.json

@@ -8,7 +8,7 @@
 
     "dependencies": {
         "Microsoft.AspNet.OData": "[5.9.1,6.0.0)",
-        "Microsoft.AspNet.WebApi.Versioning": "2.0.2-*"
+        "Microsoft.AspNet.WebApi.Versioning": "2.0.3-*"
     },
 
     "frameworks": {

src/Microsoft.AspNet.WebApi.Versioning/Controllers/ActionSelectorCacheItem.cs

@@ -226,7 +226,7 @@ private static HttpResponseMessage CreateBadRequestResponse( HttpControllerConte
 
                 var request = controllerContext.Request;
                 var exceptionFactory = new HttpResponseExceptionFactory( request );
-                return exceptionFactory.CreateBadRequestResponseForUnsupportedApiVersion( request.GetRequestedApiVersion() );
+                return exceptionFactory.CreateBadRequestResponse( request.GetRequestedApiVersion() );
             }
 
             [SuppressMessage( "Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Justification = "Caller is responsible for disposing of response instance." )]

src/Microsoft.AspNet.WebApi.Versioning/Dispatcher/ControllerSelectionResult.cs

@@ -5,44 +5,16 @@
 
     internal sealed class ControllerSelectionResult
     {
-        internal HttpControllerDescriptor Controller
-        {
-            get;
-            set;
-        }
+        internal HttpControllerDescriptor Controller { get; set; }
 
-        internal string ControllerName
-        {
-            get;
-            set;
-        }
+        internal string ControllerName { get; set; }
 
-        internal bool Succeeded
-        {
-            get
-            {
-                return this.Controller != null;
-            }
-        }
+        internal bool Succeeded => Controller != null;
 
-        internal bool CouldMatchVersion
-        {
-            get
-            {
-                return this.HasCandidates && this.RequestedVersion != null;
-            }
-        }
+        internal bool CouldMatchVersion => HasCandidates;
 
-        internal bool HasCandidates
-        {
-            get;
-            set;
-        }
+        internal bool HasCandidates { get; set; }
 
-        internal ApiVersion RequestedVersion
-        {
-            get;
-            set;
-        }
+        internal ApiVersion RequestedVersion { get; set; }
     }
-}
+}

src/Microsoft.AspNet.WebApi.Versioning/Dispatcher/HttpResponseExceptionFactory.cs

@@ -18,7 +18,6 @@ internal sealed class HttpResponseExceptionFactory
         internal HttpResponseExceptionFactory( HttpRequestMessage request )
         {
             Contract.Requires( request != null );
-
             this.request = request;
         }
 
@@ -28,33 +27,17 @@ internal HttpResponseExceptionFactory( HttpRequestMessage request )
 
         [SuppressMessage( "Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Justification = "Created exception cannot be disposed. Handled by the caller." )]
         internal HttpResponseException NewNotFoundOrBadRequestException( ControllerSelectionResult conventionRouteResult, ControllerSelectionResult directRouteResult ) =>
-            CreateBadRequestForUnsupportedApiVersion( conventionRouteResult, directRouteResult ) ?? CreateBadRequestForInvalidApiVersion() ?? CreateNotFound( conventionRouteResult );
+            CreateBadRequest( conventionRouteResult, directRouteResult ) ?? CreateNotFound( conventionRouteResult );
 
         [SuppressMessage( "Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Justification = "Created exception cannot be disposed. Handled by the caller." )]
-        internal HttpResponseMessage CreateBadRequestResponseForUnsupportedApiVersion( ApiVersion requestedVersion )
-        {
-            Contract.Requires( requestedVersion != null );
-            Contract.Ensures( Contract.Result<HttpResponseMessage>() != null );
-
-            var message = SR.VersionedResourceNotSupported.FormatDefault( request.RequestUri, requestedVersion );
-            var messageDetail = SR.VersionedControllerNameNotFound.FormatDefault( request.RequestUri, requestedVersion );
-
-            TraceWriter.Info( request, ControllerSelectorCategory, message );
-
-            return Options.CreateBadRequest( request, "UnsupportedApiVersion", message, messageDetail );
-        }
+        internal HttpResponseMessage CreateBadRequestResponse( ApiVersion requestedVersion ) =>
+            requestedVersion == null ? CreateBadRequestForUnspecifiedApiVersionOrInvalidApiVersion() : CreateBadRequestForUnsupportedApiVersion( requestedVersion );
 
         [SuppressMessage( "Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Justification = "Created exception cannot be disposed. Handled by the caller." )]
-        internal HttpResponseException CreateBadRequestForUnsupportedApiVersion( ApiVersion requestedVersion )
-        {
-            Contract.Requires( requestedVersion != null );
-            Contract.Ensures( Contract.Result<HttpResponseException>() != null );
-
-            return new HttpResponseException( CreateBadRequestResponseForUnsupportedApiVersion( requestedVersion ) );
-        }
+        internal HttpResponseException CreateBadRequest( ApiVersion requestedVersion ) => new HttpResponseException( CreateBadRequestResponse( requestedVersion ) );
 
         [SuppressMessage( "Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Justification = "Created exception cannot be disposed. Handled by the caller." )]
-        private HttpResponseException CreateBadRequestForUnsupportedApiVersion( ControllerSelectionResult conventionRouteResult, ControllerSelectionResult directRouteResult )
+        private HttpResponseException CreateBadRequest( ControllerSelectionResult conventionRouteResult, ControllerSelectionResult directRouteResult )
         {
             Contract.Requires( conventionRouteResult != null );
 
@@ -73,26 +56,47 @@ private HttpResponseException CreateBadRequestForUnsupportedApiVersion( Controll
                 return null;
             }
 
-            return CreateBadRequestForUnsupportedApiVersion( requestedVersion );
+            return CreateBadRequest( requestedVersion );
         }
 
         [SuppressMessage( "Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Justification = "Created exception cannot be disposed. Handled by the caller." )]
-        private HttpResponseException CreateBadRequestForInvalidApiVersion()
+        private HttpResponseMessage CreateBadRequestForUnspecifiedApiVersionOrInvalidApiVersion()
         {
             var requestedVersion = request.GetRawRequestedApiVersion();
             var parsedVersion = default( ApiVersion );
+            var message = default( string );
 
-            if ( string.IsNullOrEmpty( requestedVersion ) || TryParse( requestedVersion, out parsedVersion ) )
+            if ( string.IsNullOrEmpty( requestedVersion ) )
+            {
+                message = SR.ApiVersionUnspecified;
+                TraceWriter.Info( request, ControllerSelectorCategory, message );
+                return Options.CreateBadRequest( request, "ApiVersionUnspecified", message, messageDetail: null );
+            }
+            else if ( TryParse( requestedVersion, out parsedVersion ) )
             {
                 return null;
             }
 
+            message = SR.VersionedResourceNotSupported.FormatDefault( request.RequestUri, requestedVersion );
+            var messageDetail = SR.VersionedControllerNameNotFound.FormatDefault( request.RequestUri, requestedVersion );
+
+            TraceWriter.Info( request, ControllerSelectorCategory, message );
+
+            return Options.CreateBadRequest( request, "InvalidApiVersion", message, messageDetail );
+        }
+
+        [SuppressMessage( "Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Justification = "Created exception cannot be disposed. Handled by the caller." )]
+        private HttpResponseMessage CreateBadRequestForUnsupportedApiVersion( ApiVersion requestedVersion )
+        {
+            Contract.Requires( requestedVersion != null );
+            Contract.Ensures( Contract.Result<HttpResponseMessage>() != null );
+
             var message = SR.VersionedResourceNotSupported.FormatDefault( request.RequestUri, requestedVersion );
             var messageDetail = SR.VersionedControllerNameNotFound.FormatDefault( request.RequestUri, requestedVersion );
 
             TraceWriter.Info( request, ControllerSelectorCategory, message );
 
-            return new HttpResponseException( Options.CreateBadRequest( request, "InvalidApiVersion", message, messageDetail ) );
+            return Options.CreateBadRequest( request, "UnsupportedApiVersion", message, messageDetail );
         }
 
         [SuppressMessage( "Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Justification = "Created exception cannot be disposed. Handled by the caller." )]

src/Microsoft.AspNet.WebApi.Versioning/SR.Designer.cs

@@ -147,6 +147,9 @@
   <data name="ApiVersionNotSupported" xml:space="preserve">
     <value>The requested API version '{0}' is not supported.</value>
   </data>
+  <data name="ApiVersionUnspecified" xml:space="preserve">
+    <value>An API version is required, but was not specified.</value>
+  </data>
   <data name="ControllerNameNotFound" xml:space="preserve">
     <value>No route providing a controller name was found to match request URI '{0}'.</value>
   </data>

src/Microsoft.AspNet.WebApi.Versioning/SR.resx

@@ -1,5 +1,5 @@
 {
-    "version": "2.0.2-*",
+    "version": "2.0.3-*",
     "authors": [ "Microsoft" ],
     "title": "Microsoft ASP.NET Web API Versioning",
     "copyright": "Copyright \u00A9 2016. Microsoft Corporation. All rights reserved.",
@@ -26,7 +26,7 @@
         "summary": "Provides API versioning for RESTful services created using ASP.NET Web API",
         "tags": [ "Microsoft", "AspNet", "AspNetWebAPI", "Versioning" ],
         "owners": [ "Microsoft" ],
-        "releaseNotes": "\u2022 Fixed mapping of API-versioned actions by convention (Issue #55)",
+        "releaseNotes": "• Fixed responses when a version is unspecified (Issue #62)",
         "iconUrl": "http://go.microsoft.com/fwlink/?LinkID=288890",
         "licenseUrl": "https://raw.githubusercontent.com/Microsoft/aspnet-api-versioning/master/LICENSE",
         "requireLicenseAcceptance": true,