Route redirect with poem-openapi

[banool]

Hey, imagine I have an API defined with the #[derive(Openapi)] macro invocation, and in that API I've got something at the path of /hello. If I wanted an alias for the same path at /hey is there a way to do that? I don't want the alias to appear in the generated spec. Should I just add a new route handler for /hey and add the thing to ignore it from the generated spec? Thanks!

[sunli829]

What do you think if I add a hidden attribute?

#[OpenApi]
impl MyApi {
    #[oai(path = "/hello", method = "get")]
    fn hello() { }

    #[oai(path = "/hello", method = "get", hidden)]  // hidden attribute to hidden this api in the document
    fn hey() { }
}

[banool]

I think that'd work pretty well, sounds good to me! Either that or something like this:

#[OpenApi]
impl MyApi {
    #[oai(path = "/hello", method = "get", aliases = ["/hey", "/hi"])]
    fn hello() { }
}

Though the hidden attribute also sounds useful even if we do this other suggestion.

[banool]

Closing this since hidden works for this :)