Conditionally disable ASP.NET MVC Controller

Question

What is the best way to disable ASP.NET MVC controller conditionally?

I want to have an access to the controller actions if some value in web.config is \"true\" and

Answer 1

Answered here - Prevent ASP.NET Core discovering Controller in separate assembly

This approach doesn't need filters, and hides controller from swagger etc.

Answer 2

The easiest would probably be to implement a custom action filter:

http://www.asp.net/mvc/tutorials/older-versions/controllers-and-routing/understanding-action-filters-cs

You can also conditionally add a route that matches that controller that would result in a 404 being returned.

Answer 3

Cross posting from: https://stackoverflow.com/a/43044667/257470

My solution for disabling ApiController controller:

• Uses WebConfig AppSettings config flag instead of (#if DEBUG)
• Before method is invoked ExecuteAsync intercepts the invocation and checks feature toggle (feature flag);
• if feature is disabled, returns HTTP 410 GONE
• If it's common for many controllers, move the code to controller's base class

The code:

public class TestController : ApiController
{
    public override Task<HttpResponseMessage> ExecuteAsync(HttpControllerContext controllerContext, CancellationToken cancellationToken)
    {
        var featureFlag = Convert.ToBoolean(System.Configuration.ConfigurationManager.AppSettings["EnableTest"]);

        if (featureFlag == false)
        {
            return Task.FromResult(new HttpResponseMessage(HttpStatusCode.Gone));
        }

        return base.ExecuteAsync(controllerContext, cancellationToken);
    }