# rweb
[](https://travis-ci.com/kdy1/rweb)
Yet another web server framework for rust.
Installation:
```toml
[dependencies]
rweb = "0.6"
tokio = "1"
```
Installation (with automatic openapi generation):
```toml
[dependencies]
rweb = { version = "0.6", features = ["openapi"] }
serde = "1"
tokio = "1"
```
# Features
- Safe & Correct
Since `rweb` is based on [warp][], which features safety and correctness, `rweb` has same property.
- Easy to read code
```rust
use rweb::*;
use serde::{Serialize, Deserialize};
#[get("/output")]
fn output() -> String {
String::from("this returns 200 with text/plain mime type")
}
#[derive(Debug, Serialize, Deserialize, Schema)]
struct Product {
id: String,
title: String,
}
#[get("/products")]
fn products() -> Json<Vec<Product>> {
// ...
// This returns 200 with application/json
}
#[get("/products/{id}")]
fn product(id: String) -> Json<Product> {
// ...
// This returns 200 with application/json
}
#[get("/product")]
fn new_product(_product: Json<Product>) -> Json<Product> {
// ...
// This returns 200 with application/json
}
#[derive(Debug, Serialize, Deserialize, Schema)]
struct SearchOption {
query: String,
limit: usize,
page_token: String,
}
#[get("/search")]
fn search(_product: Query<SearchOption>) -> Json<Vec<Product>> {
// ...
// This returns 200 with application/json
}
#[tokio::main]
async fn main() {
serve(output().or(product()).or(products()).or(search())).run(([127, 0, 0, 1], 3030)).await;
}
```
- Websocket
If you want to use websocket, just declare a parameter typed `Ws`. It's all.
```rust
use rweb::*;
#[get("/ws")]
fn example(ws: ws::Ws) -> String {
String::new("use ws.on_upgrade or extra")
}
```
- Automatic openapi spec generation
rweb supports automatically generating openapi specification file based on your code.
See: [documentation](https://docs.rs/rweb/latest/rweb/openapi/index.html) for usage.
- API UX interaction for openapi
```rust
// Build openapi for your API
let (spec, filter) = openapi::spec().build(move || {
// Your API's filters
math::math()
.or(products::products())
.or(generic::body())
.or(generic::optional())
.or(generic::search())
.or(response::response())
});
println!("go to http://localhost:3030/docs to interact with your openapi!");
serve(filter.or(openapi_docs(spec)))
.run(([127, 0, 0, 1], 3030))
.await;
```
# Comparison
| Name | rweb | actix-web | gotham | iron | nickel | rocket | rouille | Thruster | Tide | tower-web | warp |
| ---------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| License |  |  |  |  |  |  |  |  |  |  |  |
| Version |  |  |  |  |  |  |  |  |  |  |  |
| Recent downloads |  |  |  |  |  |  |  |  |  |  |  |
| Github stars |  |  |  |  |  |  |  |  |  |  |  |
| Contributors |  |  |  |  |  |  |  |  |  |  |  |
| Activity |  |  |  |  |  |  |  |  |  |  |  |
| Base framework | hyper / warp | tokio | hyper | hyper | hyper | hyper | tiny-http | tokio | hyper | hyper | hyper |
| https | Y | Y | Y | ? | ? | ? | ? | ? | ? | ? | Y |
| http 2 | Y | Y | ? | ? | ? | ? | ? | ? | ? | ? | Y |
| async | Y | Y | Y | | | | | Y | Y | Y | Y (via different method) |
| stable rust | Y | Y | Y | Y | Y | | Y | Y | Y | Y | Y |
| openapi support | Y | | | | | | | | | | |
[warp]: https://github.com/seanmonstar/warp