https://github.com/routerify/routerify-query

A Routerify middleware which parses the request query string
https://github.com/routerify/routerify-query

hyper-rs middleware parser querystring routerify

Last synced: 5 months ago
JSON representation

A Routerify middleware which parses the request query string

• Host: GitHub
• URL: https://github.com/routerify/routerify-query
• Owner: routerify
• License: mit
• Created: 2020-05-01T10:45:04.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-02T04:24:26.000Z (over 2 years ago)
• Last Synced: 2025-01-22T02:26:17.034Z (5 months ago)
• Topics: hyper-rs, middleware, parser, querystring, routerify
• Language: Rust
• Homepage:
• Size: 34.2 KB
• Stars: 3
• Watchers: 2
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Github Actions Status](https://github.com/routerify/routerify-query/workflows/Test/badge.svg)](https://github.com/routerify/routerify-query/actions)

[![crates.io](https://img.shields.io/crates/v/routerify-query.svg)](https://crates.io/crates/routerify-query)

[![Documentation](https://docs.rs/routerify-query/badge.svg)](https://docs.rs/routerify-query)

[![MIT](https://img.shields.io/crates/l/routerify-query.svg)](./LICENSE)

# routerify-query

A [`Routerify`](https://github.com/routerify/routerify) middleware which parses the request query string and populates in the `req` object.

[Docs](https://docs.rs/routerify-query)

## Install

Add this to your `Cargo.toml`:

```toml

[dependencies]

routerify = "3"

routerify-query = "3" 

```

 

## Example

```rust

use hyper::{Body, Request, Response, Server};

use routerify::{Router, RouterService};

// Import the query_parser function and the RequestQueryExt trait.

use routerify_query::{query_parser, RequestQueryExt};

use std::{convert::Infallible, net::SocketAddr};

// A handler for "/" page. Visit: "/?username=Alice&bookname=HarryPotter" to see query values.

async fn home_handler(req: Request) -> Result, Infallible> {

    // Access the query values.

    let user_name = req.query("username").unwrap();

    let book_name = req.query("bookname").unwrap();

    Ok(Response::new(Body::from(format!(

        "User: {}, Book: {}",

        user_name, book_name

    ))))

}

// Create a router.

fn router() -> Router {

    Router::builder()

        // Attach the query_parser middleware.

        .middleware(query_parser())

        .get("/", home_handler)

        .build()

        .unwrap()

}

#[tokio::main]

async fn main() {

    let router = router();

    // Create a Service from the router above to handle incoming requests.

    let service = RouterService::new(router).unwrap();

    // The address on which the server will be listening.

    let addr = SocketAddr::from(([127, 0, 0, 1], 3001));

    // Create a server by passing the created service to `.serve` method.

    let server = Server::bind(&addr).serve(service);

    println!("App is running on: {}", addr);

    if let Err(err) = server.await {

        eprintln!("Server error: {}", err);

    }

}

```

## Contributing

Your PRs and suggestions are always welcome.