[/badge.svg?branch=master&event=push)](https://github.com/salvo-rs/salvo/actions)
[/badge.svg?branch=master&event=push)](https://github.com/salvo-rs/salvo/actions)
[/badge.svg?branch=master&event=push)](https://github.com/salvo-rs/salvo/actions)
[](https://codecov.io/gh/salvo-rs/salvo)
[](https://crates.io/crates/salvo)
[](https://crates.io/crates/salvo)
Salvo is a easy to use web framework written by rust.
🎯 Features
- Base on latest hyper, tokio;
- Websocket supported;
- Serve a static virtual directory from many physical directories;
- Middlewares support executed before or after handle;
- Easy routing:
- Path parameters and regex supported;
- Tree-like routing system;
⚡️ Quick start
You can view samples here or read docs here.
Create a new rust project:
bash
cargo new hello_salvo --bin
Add this to Cargo.toml
toml
[dependencies]
salvo = "0.9"
tokio = { version = "1", features = ["full"] }
Create a simple function handler in the main.rs file, we call it hello_world, this function just render plain text "Hello World".
```rust
use salvo::prelude::*;
[fn_handler]
async fn helloworld(req: &mut Request, depot: &mut Depot, res: &mut Response) {
res.renderplain_text("Hello World");
}
```
There are many ways to write function handler.
``` rust
[fn_handler]
async fn helloworld(res: &mut Response) {// remove params you don't used.
res.renderplain_text("Hello World");
}
[fn_handler]
async fn hello_world(res: &mut Response) -> &'static str {// just return &str
"Hello World"
}
[fn_handler]
async fn hello_world(res: &mut Response) -> anyhow::Result<&'static str> {// return Result
Ok("Hello World")
}
```
In the main function, we need to create a root Router first, and then create a server and call it's bind function:
```rust
use salvo::prelude::*;
[fn_handler]
async fn helloworld(res: &mut Response) {
res.renderplain_text("Hello World");
}
[tokio::main]
async fn main() {
let router = Router::new().get(hello_world);
let server = Server::new(router);
server.bind(([0, 0, 0, 0], 7878)).await;
}
```
Tree-like routing system
```rust
use salvo::prelude::*;
[tokio::main]
async fn main() {
let router = Router::new()
.get(index)
.push(
Router::new()
.path("users")
.before(auth)
.post(createuser)
.push(Router::new().path(r"").post(updateuser).delete(deleteuser)),
)
.push(
Router::new()
.path("users")
.get(listusers)
.push(Router::new().path(r"").get(show_user)),
);
Server::new(router).bind(([0, 0, 0, 0], 7878)).await;
}
[fn_handler]
async fn index(res: &mut Response) {
res.renderplaintext("Hello world!");
}
[fn_handler]
async fn auth(res: &mut Response) {
res.renderplaintext("user has authed\n\n");
}
[fn_handler]
async fn listusers(res: &mut Response) {
res.renderplain_text("list users");
}
[fn_handler]
async fn showuser(res: &mut Response) {
res.renderplain_text("show user");
}
[fn_handler]
async fn createuser(res: &mut Response) {
res.renderplain_text("user created");
}
[fn_handler]
async fn updateuser(res: &mut Response) {
res.renderplain_text("user updated");
}
[fn_handler]
async fn deleteuser(res: &mut Response) {
res.renderplain_text("user deleted");
}
```
More Examples
Your can find more examples in examples folder:
- basicauth.rs
- compression.rs
- filelist.rs
- proxy.rs
- remoteaddr.rs
- routing.rs
- ssechat.rs
- sse.rs
- tls.rs
- todos.rs
- unixsocket.rs
- wschat.rs
- ws.rs
☕ Supporters
Salvo is an open source project. If you want to support Salvo, you can ☕ buy a coffee here.
⚠️ License
Salvo is licensed under either of
* Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)