How to map custom routes for Umbraco api controllers

In this post I show you how you can map custom routes for your Umbraco Api Controller.

Lets say you are writing an import controller and you want to customise the route to something like this:

https://mydomain.com/api/import/products

Then first you will need to decorate the class and the action like this:

using Newtonsoft.Json.Linq;
using System.Web.Http;
using Umbraco.Web.WebApi;

namespace CodeShare.Web.Controllers.Api
{
    [RoutePrefix("api/import")]
    public class ProductImportApiController : UmbracoApiController
    {
        [Route("products")]
        [HttpGet]
        public IHttpActionResult ImportProducts()
        {
            dynamic data = new JObject();
            data.message = "The product import was successful";
            return Ok(data);
        }
    }
}

And the code to map the routes correctly for you is here:

using System.Web.Http;
using Umbraco.Core.Composing;

namespace CodeShare.Core.Composing
{
    [RuntimeLevel(MinLevel = RuntimeLevel.Run)]
    public class RegisterCustomApiRoutesComposer : ComponentComposer&lt;RegisterCustomApiRoutesComponent&gt;
    { }

    public class RegisterCustomApiRoutesComponent : IComponent
    {
        public void Initialize()
        {
            GlobalConfiguration.Configuration.MapHttpAttributeRoutes();
            GlobalConfiguration.Configuration.Initializer(GlobalConfiguration.Configuration);
        }

        public void Terminate()
        {
            //nothing to terminate
        }
    }
}

Make sure you do a clean and rebuild and you should be good to go.

EDIT

Thanks to Anders Bjerner for pointing the following out.

You can also add parameters:

[Route("api/employees/{id}")]
[Route("api/employees/{type}/{id}")]
public object GetEmployeeById(string id, string type = null) { }

You can even add constraints:

[Route("api/employees/{type:int}/{id:guid}")]

https://docs.microsoft.com/en-us/aspnet/web-api/overview/web-api-routing-and-actions/attribute-routing-in-web-api-2#route-constraints