Multiple API controllers in different MVC Areas share the same namespace

Question

I have 2 areas with 2 API controllers that have the same AI controller name, but different namespaces and which are configured via 2 different MapHttpRoute() calls with their unique names and routes. They also compile successfully without an issue. However, there are matching action methods in both and when I make a call to one I get back the exception below.

It's clear from the exception message that it's not supported but is there an elegant resolution so I don't have to name my API controllers uniquely despite being in separate namespaces?

Exception:

Multiple types were found that match the controller named 'SomethingApi'. This can happen if the route that services this request ('route-one/api/something/{action}') found multiple controllers defined with the same name but differing namespaces, which is not supported.

Route example:

public static void RegisterApiRoutes(HttpConfiguration config)
{
    // URL: /route-one/api/something/

    config.Routes.MapHttpRoute(
        "RoutOne.Api.Something",
        "route-one/api/something/{action}",
        new { controller = "SomethingApi" }
    );
}

Routes in both namespaces are called from the project's WebApiConfig:

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        RouteOneAreaRegistration.RegisterApiRoutes(config);
        RouteTwoAreaRegistration.RegisterApiRoutes(config);
    }
}

Can you show both route registrations for the two separate areas? It appears as though MVC believes you are registering both areas/routes the same... — xspydr
– xspydr, Commented Jan 27, 2014 at 16:24
@Jason - I can guarantee both routes are unique, they have unique names and routes. — Bern
– Bern, Commented Jan 27, 2014 at 16:32

danludwig · Accepted Answer · 2014-01-27 16:50:45Z

1

It seems to me like the elegant solution here is to name your ApiControllers differently. If they do not do the same thing, reflect that in the controller name. If they do the same thing, then you don't need separate controllers.

Another solution could be to have one controller with both of your different actions, named differently.

It's difficult to gauge why this is not an elegant way to resolve the problem given the abstract nature of your question. Perhaps if you told us what the controllers are named, how they differ, and why they are in separate areas, someone could provide a more appropriate answer for you.

answered Jan 27, 2014 at 16:50

danludwig

47.4k27 gold badges164 silver badges240 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Bern Over a year ago

Thanks, the catch is they do very similar things, just on different business units within the company. So the business unit name difference is reflected in the namespace (and through the MVC area structure). Everything else is named according to the function it performs. I do understand your point though.

danludwig Over a year ago

Can you make the business unit name or other id a route parameter / action method argument? "api/something/{action}/{businessUnit}"?

Bern Over a year ago

I like your thinking but the business unit is a included in the segment earlier on, in fact the business units are reflected by the MVC areas. It just happens in this case two of them perform very similar actions on their respective domains.

Collectives™ on Stack Overflow

Multiple API controllers in different MVC Areas share the same namespace

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related