C#•4y ago

❔ ASP.NET Core how to let a controller be mapped only in development mode

This is pretty easy to do with minimal API's, you just do a check and map only if it succeeds:

app.UseEndpoints(endpoints =>
{
    if (app.Environment.IsDevelopment())
    {
        endpoints.Map("whatever", () => "blah");
    }
});

app.UseEndpoints(endpoints =>
{
    if (app.Environment.IsDevelopment())
    {
        endpoints.Map("whatever", () => "blah");
    }
});

app.UseEndpoints(endpoints =>
{
    if (app.Environment.IsDevelopment())
    {
        endpoints.Map("whatever", () => "blah");
    }
});

app.UseEndpoints(endpoints =>
{
    if (app.Environment.IsDevelopment())
    {
        endpoints.Map("whatever", () => "blah");
    }
});

However, as I've noticed, minimal endpoints have somewhat different semantics than normal controller actions. For example, they can't match catch all routes. So the following won't work:

endpoints.Map("/{**catchAll}", async (HttpContext http, string catchAll) => "whatever");

endpoints.Map("/{**catchAll}", async (HttpContext http, string catchAll) => "whatever");

endpoints.Map("/{**catchAll}", async (HttpContext http, string catchAll) => "whatever");

endpoints.Map("/{**catchAll}", async (HttpContext http, string catchAll) => "whatever");

With controllers I think it does work.
Minimal API's specificity is quite weird too. They'd match a request even having a less specific route than some of the controllers. It's as though they're treated completely separately, idk.

AntonOP•11/12/22, 10:38 AM

To be clear, I don't want to make a filter and then check if it's development mode in the filter of the controller, or whatever. I don't want it to be mapped at all if it's not development.

AAnton This is pretty easy to do with minimal API's, you just do a check and map only i...

plam•11/12/22, 11:26 AM

As far as I am concerned, it is actually possible via using IHostEnvironment inside your controller class, and basically checking for the same thing:

if (_hostEnvironment.IsDevelopment()) {..}

if (_hostEnvironment.IsDevelopment()) {..}

Additionally, you're actually able to implement a filter factory interface just to use [DevOnly] attribute before your controller class.

Pplam As far as I am concerned, it is actually possible via using IHostEnvironment ins...

AntonOP•11/12/22, 12:51 PM

can you elaborate?

AntonOP•11/12/22, 12:51 PM

would I throw in the constructor or something? I don't understand

AntonOP•11/12/22, 12:52 PM

can filters run prior to mapping even?

AntonOP•11/12/22, 12:52 PM

or like while resolving what to map

AntonOP•11/12/22, 12:54 PM

yeah I've seen this post, I'm confused tho

AAnton can you elaborate?

plam•11/12/22, 12:54 PM

After the successful injection of the interface you're pretty much able to check for the environment inside of the body of action.

public class ExampleController : Controller
{
    private readonly IHostEnvironment _hostEnvironment;

    public ExampleController(IHostEnvironment hostEnvironment)
    {
        _hostEnvironment = hostEnvironment;
    }

    public IActionResult View()
    {
        if (!_hostEnvironment.IsDevelopment()) // Return something else for Development.
    }
}

public class ExampleController : Controller
{
    private readonly IHostEnvironment _hostEnvironment;

    public ExampleController(IHostEnvironment hostEnvironment)
    {
        _hostEnvironment = hostEnvironment;
    }

    public IActionResult View()
    {
        if (!_hostEnvironment.IsDevelopment()) // Return something else for Development.
    }
}

AntonOP•11/12/22, 12:54 PM

would the filter in the second answer run once prior to the mapping being established, or every time

Pplam After the successful injection of the interface you're pretty much able to check...

AntonOP•11/12/22, 12:55 PM

no this is not what I want

AntonOP•11/12/22, 12:55 PM

like I said, I don't want it to be mapped at all if it's development

AntonOP•11/12/22, 12:55 PM

this would still map it

AAnton like I said, I don't want it to be mapped at all if it's development

plam•11/12/22, 12:57 PM

https://stackoverflow.com/questions/11604773/conditionally-disable-asp-net-mvc-controller

Stack Overflow

Conditionally disable ASP.NET MVC Controller

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 404 if it's "false"

Should I wr...

plam•11/12/22, 12:58 PM

There's an answer with an implementation of a filter, go for it

AAnton would the filter in the second answer run once prior to the mapping being establ...

plam•11/12/22, 12:58 PM

It depends

Pplam https://stackoverflow.com/questions/11604773/conditionally-disable-asp-net-mvc-c...

AntonOP•11/12/22, 2:38 PM

This would still map the controller and its actions, I really don't want that

AntonOP•11/12/22, 2:39 PM

Like I'm just tempted to put a

#if DEVELOPMENT

#if DEVELOPMENT

or something on the class

AntonOP•11/12/22, 2:39 PM

but I see that people don't usually do that in ASP.NET Core

AntonOP•11/12/22, 2:39 PM

Don't know why tho

AntonOP•11/12/22, 2:43 PM

Not debug

AntonOP•11/12/22, 2:43 PM

There should be a separate

PRODUCTION

PRODUCTION

that I would define in a production build

AntonOP•11/12/22, 2:44 PM

debug vs production should be two separate concepts

AntonOP•11/12/22, 2:44 PM

that's not what I mean

AntonOP•11/12/22, 2:44 PM

I mean you may still want to build for prodcution in debug mode

AntonOP•11/12/22, 2:44 PM

for testing purposes

AntonOP•11/12/22, 2:45 PM

It's fine, I have a Nuke task doing a production build

plam•11/12/22, 2:46 PM

Why don't you just return NotFound as for the controller which is flagged with attribute for DevOnly or sum

AntonOP•11/12/22, 2:47 PM

because it's a catch all controller

AntonOP•11/12/22, 2:47 PM

I may want to have some other logic for that case, defined somewhere else

AntonOP•11/12/22, 2:47 PM

it's extra work done for no reason

Accord•11/22/22, 8:44 PM

Was this issue resolved? If so, run

/close

/close

otherwise I will mark this as stale and this post will be archived until there is new activity.

❔ ASP.NET Core how to let a controller be mapped only in development mode

Similar Threads

Similar Threads

Similar Threads