[FEATURE] Easy way to enable/disable endpoint

Is your feature request related to a problem? Please describe.

This is not a problem but rather something that occurs quite commonly. Sometimes you just want to expose a certain endpoint based on configuration settings or environment. Currently there is include_in_schema flag that hides the endpoint in OpenAPI schema but the actual endpoint is still present and responsive. There should be a way to disable endpoint entirely from being exposed.

Describe the solution you’d like

I think there should be a disabled or enabled flag on APIRoute.api_route method to easily enable the endpoint and not exposing it at all.

Issue Analytics

State:
Created 4 years ago
Comments:11 (6 by maintainers)

Top GitHub Comments

2reactions

dmontagucommented, Sep 20, 2019

@LKay If you want to exclude based on a boolean flag, is there a reason you couldn’t just put the route definition inside a conditional block, conditioning on the condition you’d pass as enabled or disabled anyway? It seems to me even if the flag you are requesting was added, the following would be equivalent:

if not exclude_condition:
    @app.get("/excluded")
    async def excluded_list():
        return {"excluded": True}

@app.get("/excluded", disabled=exclude_condition)
async def excluded_list():
    return {"excluded": True}

The benefit to the first approach would be that it wouldn’t require a new keyword argument on all of the route decorators (and there are already so many!).

Is there something this approach wouldn’t handle?

1reaction

LKaycommented, Nov 27, 2019

Handled using wrapping if statements around routes.