How can I parse query strings in actix-web?

17
votes

How can I parse the name and color arguments from the following URL using actix-web?

http://example.com/path/to/page?name=ferret&color=purple

I suppose my path should be /path/to/page and then when I try to query for name I receive an empty string (req.match_info().query("name") where req: &HttpRequest).

The only documentation I found is about matching names (e.g., if the path is /people/{page}/ it'll match /people/123/ such that page = 123 but that's not what I want.

3
rustrust-actix

3 Answers

18
votes

It looks like they removed the query function and just have a query_string function. You could use a crate for this called qstring:

use qstring::QString;
...
let query_str = req.query_string(); // "name=ferret"
let qs = QString::from(query_str);
let name = qs.get("name").unwrap(); // "ferret"

You could also use an extractor to deserialize the query params into a struct with Serde

use serde::Deserialize;

#[derive(Deserialize)]
struct Info {
    username: String,
}

fn index(info: web::Query<Info>) -> Result<String, actix_web::Error> {
    Ok(format!("Welcome {}!", info.username))
}

Note that the handler will only be called if the query username is actually present in the request. This would call the handler:

curl "http://localhost:5000?username=joe"

but these would not:

curl "http://localhost:5000"
curl "http://localhost:5000?password=blah"

If you need optional parameters, just make the properties in your struct Options.

username: Option<String>

You can also use multiple web::Query<SomeType> parameters in a handler.

4
votes

This is for actix-web v0.7

I managed to get it work by using:

let name = req.query().get("name").unwrap(); // name = "ferret"
1
votes

actix_web::web::query parses query strings:

use actix_web::{web, App};
use serde_derive::Deserialize;

#[derive(Debug, Deserialize)]
pub struct Params {
    name: String,
    color: String,
}

#[get("/path/to/page")]
async fn handler(req: HttpRequest) -> HttpResponse {
    let params = web::Query::<Params>::from_query(req.query_string()).unwrap();
    HttpResponse::Ok().body(format!("{:?}", params))
}

The official documentation has another example.