WebAPI Attribute Routing Not Picking Up Routes

Question

Sitecore 8.2 rev 160729

My understanding is that, as of Sitecore 8.2, you no longer need to call .MapHttpAttributeRoutes() because it's now included (in fact, it'll throw an error if you do). However, Sitecore is not picking up my ApiControllers using attribute based routing.

public class SampleController : ApiController
{
    [Route("-/api/sample/test"), HttpGet]
    public string Test()
    {
        return "Hello World!";
    }
}

The above route does not appear in the route tables, and the URL gives me a 404.

Do I need to tell Sitecore which assemblies to look for routes in, or is there an additional configuration step I'm missing?

Answer 1

I think since you have a DI configured that will be resetting any routes registered after you've added them so you need to do this afterwards in the initialize Pipeline like so:

Create a pipeline to register your route:

public class RegisterMySampleRoute
{
    public virtual void Process(PipelineArgs args)
    {
        RouteTable.Routes.MapHttpRoute("my_sample_route", 
            "mysample/api/{controller}/{action}", 
            new {controller = "SampleController"}
        );
    }
}

Then patch it in like so:

<?xml version="1.0"?>
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
    <sitecore>
        <pipelines>
            <initialize>
                <processor type="MyNamespace.Pipelines.RegisterMySampleRoute, MyNamespace" patch:before="processor[@type='Sitecore.Mvc.Pipelines.Loader.InitializeRoutes, Sitecore.Mvc']" />
            </initialize>
        </pipelines>
    </sitecore>
</configuration>

That should do it.