#hyper #router #routing #middleware #hyper-rs

routerify

A lightweight, idiomatic, composable and modular router implementation with middleware support for the Rust HTTP library hyper.rs

15 releases (stable)

new 2.0.0-beta-4 Mar 2, 2021
2.0.0-beta-2 Feb 16, 2021
2.0.0-beta-1 Dec 4, 2020
1.1.4 May 30, 2020
0.1.1 Mar 24, 2020

#6 in HTTP server

Download history 67/week @ 2020-11-10 115/week @ 2020-11-17 62/week @ 2020-11-24 94/week @ 2020-12-01 121/week @ 2020-12-08 201/week @ 2020-12-15 116/week @ 2020-12-22 303/week @ 2020-12-29 657/week @ 2021-01-05 619/week @ 2021-01-12 338/week @ 2021-01-19 210/week @ 2021-01-26 129/week @ 2021-02-02 229/week @ 2021-02-09 275/week @ 2021-02-16 166/week @ 2021-02-23

1,158 downloads per month
Used in less than 7 crates

MIT license

135KB
1.5K SLoC

Github Actions Status crates.io Documentation Contributors MIT

Routerify

The Routerify provides a lightweight, idiomatic, composable and modular router implementation with middleware support for the Rust HTTP library hyper.rs.

There are a lot of web server frameworks for Rust applications out there and hyper.rs being comparably very fast and ready for production use is one of them, and it provides only low level API. It doesn't provide any complex routing feature. So, Routerify extends the hyper.rs library by providing that missing feature without compromising any performance.

The Routerify offers the following features:

  • 📡 Allows defining complex routing logic.
  • 🔨 Provides middleware support.
  • 🌀 Supports Route Parameters.
  • 🚀 Fast as it's using RegexSet to match routes.
  • 🍺 It supports any response body type as long as it implements the HttpBody trait.
  • ❗ Provides a flexible error handling strategy.
  • 💁 Provides WebSocket support out of the box.
  • 🔥 Allows data/state sharing across the route and middleware handlers.
  • 🍗 Exhaustive examples and well documented.

To generate a quick server app using Routerify and hyper.rs, please check out hyper-routerify-server-template.

Benchmarks

Framework Language Requests/sec
hyper v0.13 Rust 1.43.0 112,557
routerify v1.1 with hyper v0.13 Rust 1.43.0 112,320
gotham v0.4.0 Rust 1.43.0 100,097
actix-web v2 Rust 1.43.0 96,397
warp v0.2 Rust 1.43.0 81,912
go-httprouter, branch master Go 1.13.7 74,958
Rocket, branch async Rust 1.43.0 2,041 ?

For more info, please visit Benchmarks.

Install

Add this to your Cargo.toml file:

[dependencies]
routerify = "2.0.0-beta-4"

Basic Example

A simple example using Routerify with hyper.rs would look like the following:

use hyper::{Body, Request, Response, Server, StatusCode};
// Import the routerify prelude traits.
use routerify::prelude::*;
use routerify::{Middleware, Router, RouterService, RequestInfo};
use std::{convert::Infallible, net::SocketAddr};

// Define an app state to share it across the route handlers and middlewares.
struct State(u64);

// A handler for "/" page.
async fn home_handler(req: Request<Body>) -> Result<Response<Body>, Infallible> {
    // Access the app state.
    let state = req.data::<State>().unwrap();
    println!("State value: {}", state.0);

    Ok(Response::new(Body::from("Home page")))
}

// A handler for "/users/:userId" page.
async fn user_handler(req: Request<Body>) -> Result<Response<Body>, Infallible> {
    let user_id = req.param("userId").unwrap();
    Ok(Response::new(Body::from(format!("Hello {}", user_id))))
}

// A middleware which logs an http request.
async fn logger(req: Request<Body>) -> Result<Request<Body>, Infallible> {
    println!("{} {} {}", req.remote_addr(), req.method(), req.uri().path());
    Ok(req)
}

// Define an error handler function which will accept the `routerify::Error`
// and the request information and generates an appropriate response.
async fn error_handler(err: routerify::Error, _: RequestInfo) -> Response<Body> {
    eprintln!("{}", err);
    Response::builder()
        .status(StatusCode::INTERNAL_SERVER_ERROR)
        .body(Body::from(format!("Something went wrong: {}", err)))
        .unwrap()
}

// Create a `Router<Body, Infallible>` for response body type `hyper::Body`
// and for handler error type `Infallible`.
fn router() -> Router<Body, Infallible> {
    // Create a router and specify the logger middleware and the handlers.
    // Here, "Middleware::pre" means we're adding a pre middleware which will be executed
    // before any route handlers.
    Router::builder()
        // Specify the state data which will be available to every route handlers,
        // error handler and middlewares.
        .data(State(100))
        .middleware(Middleware::pre(logger))
        .get("/", home_handler)
        .get("/users/:userId", user_handler)
        .err_handler_with_info(error_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], 3000));

    // 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);
   }
}

Documentation

Please visit: Docs for an exhaustive documentation.

Examples

The examples.

Contributing

Your PRs and suggestions are always welcome.

Dependencies

~8MB
~164K SLoC