-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduced versioning via Accept header with our own media type
- Loading branch information
Joakim Skoog
committed
Jan 2, 2016
1 parent
45aa639
commit 4d786fd
Showing
7 changed files
with
189 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 7 additions & 8 deletions
15
...IceAndFire/Controllers/BooksController.cs → ...AndFire/Controllers/v0/BooksController.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
162 changes: 162 additions & 0 deletions
162
AnApiOfIceAndFire/Infrastructure/AcceptHeaderControllerSelector.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Globalization; | ||
| using System.Linq; | ||
| using System.Net; | ||
| using System.Net.Http; | ||
| using System.Text.RegularExpressions; | ||
| using System.Web.Http; | ||
| using System.Web.Http.Controllers; | ||
| using System.Web.Http.Dispatcher; | ||
| using System.Web.Http.Routing; | ||
|
|
||
| namespace AnApiOfIceAndFire.Infrastructure | ||
| { | ||
| public class AcceptHeaderControllerSelector : IHttpControllerSelector | ||
| { | ||
| public const string AllowedAcceptHeaderMediaType = "application/vnd.anapioficeandfire+json"; | ||
| public const string AllowedAcceptHeaderMediaTypeParamter = "version"; | ||
|
|
||
| private const string ControllerKey = "controller"; | ||
|
|
||
| private readonly HttpConfiguration _configuration; | ||
|
|
||
| private readonly Lazy<IDictionary<string, HttpControllerDescriptor>> _controllers; | ||
| private readonly ICollection<string> _duplicates; | ||
|
|
||
| private string _defaultControllerVersion; | ||
|
|
||
| public AcceptHeaderControllerSelector(HttpConfiguration configuration) | ||
| { | ||
| if (configuration == null) throw new ArgumentNullException(nameof(configuration)); | ||
| _configuration = configuration; | ||
| _duplicates = new HashSet<string>(StringComparer.OrdinalIgnoreCase); | ||
| _controllers = new Lazy<IDictionary<string, HttpControllerDescriptor>>(InitialiseControllerDictionary); | ||
| } | ||
|
|
||
| public HttpControllerDescriptor SelectController(HttpRequestMessage request) | ||
| { | ||
| IHttpRouteData routeData = request.GetRouteData(); | ||
| if (routeData == null) | ||
| { | ||
| throw new HttpResponseException(HttpStatusCode.NotFound); | ||
| } | ||
|
|
||
| string version = GetVersionFromMediaType(request); | ||
| if (version == null) | ||
| { | ||
| throw new HttpResponseException(HttpStatusCode.NotFound); | ||
| } | ||
|
|
||
| string controllerName = GetRouteVariable<string>(routeData, ControllerKey); | ||
| if (controllerName == null) | ||
| { | ||
| throw new HttpResponseException(HttpStatusCode.NotFound); | ||
| } | ||
|
|
||
| // Find a matching controller. | ||
| string key = string.Format(CultureInfo.InvariantCulture, "v{0}.{1}", version, controllerName); | ||
|
|
||
| HttpControllerDescriptor controllerDescriptor; | ||
| if (_controllers.Value.TryGetValue(key, out controllerDescriptor)) | ||
| { | ||
| return controllerDescriptor; | ||
| } | ||
| if (_duplicates.Contains(key)) | ||
| { | ||
| throw new HttpResponseException(request.CreateErrorResponse(HttpStatusCode.InternalServerError, "Multiple controllers were found that match this request.")); | ||
| } | ||
|
|
||
| throw new HttpResponseException(HttpStatusCode.NotFound); | ||
| } | ||
|
|
||
| public IDictionary<string, HttpControllerDescriptor> GetControllerMapping() | ||
| { | ||
| return _controllers.Value; | ||
| } | ||
|
|
||
| private IDictionary<string, HttpControllerDescriptor> InitialiseControllerDictionary() | ||
| { | ||
| var dictionary = new Dictionary<string, HttpControllerDescriptor>(StringComparer.OrdinalIgnoreCase); | ||
| var versionedNamespaces = new List<string>(); | ||
|
|
||
| // Create a lookup table where key is "namespace.controller". The value of "namespace" is the last | ||
| // segment of the full namespace. For example: | ||
| // MyApplication.Controllers.V1.ProductsController => "V1.Products" | ||
| IAssembliesResolver assembliesResolver = _configuration.Services.GetAssembliesResolver(); | ||
| IHttpControllerTypeResolver controllersResolver = _configuration.Services.GetHttpControllerTypeResolver(); | ||
|
|
||
| ICollection<Type> controllerTypes = controllersResolver.GetControllerTypes(assembliesResolver); | ||
|
|
||
| foreach (Type t in controllerTypes) | ||
| { | ||
| var segments = t.Namespace.Split(Type.Delimiter); | ||
|
|
||
| // For the dictionary key, strip "Controller" from the end of the type name. | ||
| // This matches the behavior of DefaultHttpControllerSelector. | ||
| var controllerName = t.Name.Remove(t.Name.Length - DefaultHttpControllerSelector.ControllerSuffix.Length); | ||
| var namespaceName = segments[segments.Length - 1]; | ||
|
|
||
| versionedNamespaces.Add(namespaceName.Remove(0,1)); //Remove the first character which should be v. Since we will add v whilst selecting the controller | ||
|
|
||
| var key = string.Format(CultureInfo.InvariantCulture, "{0}.{1}", namespaceName, controllerName); | ||
|
|
||
| // Check for duplicate keys. | ||
| if (dictionary.Keys.Contains(key)) | ||
| { | ||
| _duplicates.Add(key); | ||
| } | ||
| else | ||
| { | ||
| dictionary[key] = new HttpControllerDescriptor(_configuration, t.Name, t); | ||
| } | ||
| } | ||
|
|
||
| // Remove any duplicates from the dictionary, because these create ambiguous matches. | ||
| // For example, "Foo.V1.ProductsController" and "Bar.V1.ProductsController" both map to "v1.products". | ||
| foreach (string s in _duplicates) | ||
| { | ||
| dictionary.Remove(s); | ||
| } | ||
|
|
||
| //Calculate the default version, we choose to use the highest available version as the default one | ||
| _defaultControllerVersion = versionedNamespaces.OrderByDescending(x => x).First(); | ||
|
|
||
| return dictionary; | ||
| } | ||
|
|
||
| // Get a value from the route data, if present. | ||
| private static T GetRouteVariable<T>(IHttpRouteData routeData, string name) | ||
| { | ||
| object result; | ||
| if (routeData.Values.TryGetValue(name, out result)) | ||
| { | ||
| return (T)result; | ||
| } | ||
| return default(T); | ||
| } | ||
|
|
||
| private string GetVersionFromMediaType(HttpRequestMessage request) | ||
| { | ||
| var acceptHeader = request.Headers.Accept; | ||
|
|
||
| foreach (var mime in acceptHeader.OrderByDescending(x => x.Quality)) | ||
| { | ||
| if (string.Equals(mime.MediaType, AllowedAcceptHeaderMediaType, StringComparison.InvariantCultureIgnoreCase)) | ||
| { | ||
| var version = mime.Parameters.FirstOrDefault(x => x.Name.Equals(AllowedAcceptHeaderMediaTypeParamter, StringComparison.InvariantCultureIgnoreCase)); | ||
|
|
||
| if (version == null) | ||
| { | ||
| return _defaultControllerVersion; | ||
| } | ||
|
|
||
| return version.Value; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| return _defaultControllerVersion; | ||
| } | ||
| } | ||
| } |