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<RegisterCustomApiRoutesComponent>
    { }

    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

Paul Seal

Umbraco MVP and .NET Web Developer from Derby (UK) who specialises in building Content Management System (CMS) websites using MVC with Umbraco as a framework. Paul is passionate about web development and programming as a whole. Apart from when he's with his wife and son, if he's not writing code, he's thinking about it or listening to a podcast about it.

Proudly sponsored by

Moriyama

  • Moriyama build, support and deploy Umbraco, Azure and ASP.NET websites and applications.
AppVeyor

  • CI/CD service for Windows, Linux and macOS
  • Build, test, deploy your apps faster, on any platform.
stkrs

  • Custom stickers for startups, artists and brands.
  • Bespoke easy-apply, removable, custom brand stickers printed in the UK.
elmah.io

  • elmah.io is the easy error logging and uptime monitoring service for .NET.
  • Take back control of your errors with support for all .NET web and logging frameworks.
uSync Complete

  • uSync.Complete gives you all the uSync packages, allowing you to completely control how your Umbraco settings, content and media is stored, transferred and managed across all your Umbraco Installations.