Skip to content

Instantly share code, notes, and snippets.

@Ulriksen
Last active July 14, 2016 14:42
using System;
using System.Collections.ObjectModel;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Web.Http;
using System.Web.Http.Controllers;
using System.Web.Http.Description;
using System.Web.Http.Routing;
namespace ApiDocConstraint.ApiVersion
{
public class VersionedApiExplorer<TVersionConstraint> : IApiExplorer
{
private IApiExplorer _innerApiExplorer;
private HttpConfiguration _configuration;
private Lazy<Collection<ApiDescription>> _apiDescriptions;
private MethodInfo _apiDescriptionPopulator;
public VersionedApiExplorer(IApiExplorer apiExplorer, HttpConfiguration configuration)
{
_innerApiExplorer = apiExplorer;
_configuration = configuration;
_apiDescriptions = new Lazy<Collection<ApiDescription>>(
new Func<Collection<ApiDescription>>(Init));
}
public Collection<ApiDescription> ApiDescriptions
{
get { return _apiDescriptions.Value; }
}
private Collection<ApiDescription> Init()
{
var descriptions = _innerApiExplorer.ApiDescriptions;
var controllerSelector = _configuration.Services.GetHttpControllerSelector();
var controllerMappings = controllerSelector.GetControllerMapping();
var flatRoutes = FlattenRoutes(_configuration.Routes);
var result = new Collection<ApiDescription>();
foreach (var description in descriptions)
{
result.Add(description);
if (controllerMappings != null && description.Route.Constraints.Any(c => c.Value is TVersionConstraint))
{
var matchingRoutes = flatRoutes.Where(r => r.RouteTemplate == description.Route.RouteTemplate && r != description.Route);
foreach(var route in matchingRoutes)
GetRouteDescriptions(route,result);
}
}
return result;
}
private void GetRouteDescriptions(IHttpRoute route,Collection<ApiDescription> apiDescriptions)
{
var actionDescriptor = route.DataTokens["actions"] as IEnumerable<HttpActionDescriptor>;
if (actionDescriptor != null && actionDescriptor.Count() > 0)
GetPopulateMethod().Invoke(_innerApiExplorer, new object[] { actionDescriptor.First(), route, route.RouteTemplate, apiDescriptions });
}
private MethodInfo GetPopulateMethod()
{
if (_apiDescriptionPopulator == null)
_apiDescriptionPopulator = _innerApiExplorer.GetType().GetMethods(BindingFlags.NonPublic | BindingFlags.Instance).FirstOrDefault(
m => m.Name == "PopulateActionDescriptions" && m.GetParameters().Length == 4);
return _apiDescriptionPopulator;
}
public static IEnumerable<IHttpRoute> FlattenRoutes(IEnumerable<IHttpRoute> routes)
{
var flatRoutes = new List<HttpRoute>();
foreach (var route in routes)
{
if (route is HttpRoute)
yield return route;
var subRoutes = route as IReadOnlyCollection<IHttpRoute>;
if (subRoutes != null)
foreach (IHttpRoute subRoute in FlattenRoutes(subRoutes))
yield return subRoute;
}
}
}
}
@pasteusernamehere
Copy link

Nice work Harald! I ran into this same issue recently and found this code to be of great value. I did find one issue though that I have corrected in my version. Below is slightly refactored version of your Init() method. The major difference to note is the call to GetAllRoutes (FlattenRoutes). GetAllRoutes via the Where emits only routes that are not already present in ApiDescriptions. I found controllers that have routes that differ only by action caused issues in your version.

    private Collection<ApiDescription> LoadApiDescriptions()
    {
        var apiDescriptions = _apiExplorer.ApiDescriptions;

        var controllerMappings = _configuration.Services.GetHttpControllerSelector().GetControllerMapping();

        //Get all routes that are not already represented in ApiDescriptions
        var routes =
            GetAllRoutes(_configuration.Routes)
                .Where(route => !apiDescriptions.Select(x => x.Route).Contains(route))
                .ToList();

        var result = new Collection<ApiDescription>();

        //Add each ApiDescription to the outbound collection.  
        foreach (var apiDescription in apiDescriptions)
        {
            result.Add(apiDescription);

            if (controllerMappings == null || !apiDescription.Route.Constraints.Any(c => c.Value is TVersionConstraint))
            {
                continue;
            }

            var description = apiDescription;

            //If a route template exists that matches an existing template but has a different route add it to the outbound collection
            //Why would the template be the same but the route different?  This route may be versioned which means its constraint and parameters may differ.
            foreach (var route in routes.Where(r => r.RouteTemplate == description.Route.RouteTemplate && r != description.Route))
            {
                AddRouteDescription(route, result);
            }
        }

        return result;
    }

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment