First time using poem... hit a weird issue with Query...

[haydonryan]

I was putting together some code from youtube videos, searching the web ,and looking at the sample code.

I ran into an issue where this compiles and runs, but gives a runtime error response:

$ curl http://localhost:3000/api/hello?name=sunli
invalid type: map, expected option

use poem::web::Query;
use poem::{listener::TcpListener, Route};
use poem_openapi::{payload::PlainText, OpenApi, OpenApiService};

struct Api;

#[OpenApi]
impl Api {
    #[oai(path = "/hello", method = "get")]
    async fn index(&self, name: Query<Option<String>>) -> PlainText<String> {
        match name.0 {
            Some(name) => PlainText(format!("hello, {}!", name)),
            None => PlainText("hello!".to_string()),
        }
    }
}

#[tokio::main]
async fn main() -> Result<(), std::io::Error> {
    let api_service =
        OpenApiService::new(Api, "Hello World", "1.0").server("http://localhost:3000/api");
    let ui = api_service.swagger_ui();
    let app = Route::new().nest("/api", api_service).nest("/", ui);

    poem::Server::new(TcpListener::bind("0.0.0.0:3000"))
        .run(app)
        .await
}

Can you spot what I did wrong? I used use poem::web::Query; instead of use poem_openapi::param::Query

I didn't put this as an issue, but wondering if there's something we can do to cause this to be a compiler error instead of a cryptic runtime error?

It may be just a learning experience for me, but wanted to see if this should be made an issue or not.

[InterStella0]

i've had this similar experience when i first started using poem, though i quickly know what went wrong the second time i got it. The only way i think this can be avoided is to name it differently, i.e, Query => QueryParam for the receiving parameters of an endpoint. But i do notice these naming issues quite often on other crates as well