warp README

warp

A super-easy, composable, web server framework for warp speeds.

The fundamental building block of warp is the Filter: they can be combined and composed to express rich requirements on requests.

Thanks to its Filter system, warp provides these out of the box:

Path routing and parameter extraction
Header requirements and extraction
Query string deserialization
JSON and Form bodies
Multipart form data
Static Files and Directories
Websockets
Access logging
Gzip, Deflate, and Brotli compression

Since it builds on top of hyper, you automatically get:

HTTP/1
HTTP/2
Asynchronous
One of the fastest HTTP implementations
Tested and correct

Example

Add warp and Tokio to your dependencies:

tokio = { version = "1", features = ["full"] }
warp = { version = "0.4", features = ["server"] }

And then get started in your main.rs:

use warp::Filter;

#[tokio::main]
async fn main() {
    // GET /hello/warp => 200 OK with body "Hello, warp!"
    let hello = warp::path!("hello" / String)
        .map(|name| format!("Hello, {}!", name));

    warp::serve(hello)
        .run(([127, 0, 0, 1], 3030))
        .await;
}

For more information you can check the docs or the examples.