Salvo is an extremely simple and powerful Rust web backend framework. Only basic Rust knowledge is required to develop backend services.
🎯 Features
- Built with Hyper and Tokio;
- Unified middleware and handle interface;
- Limitless routers nesting;
- Every router can have one or many middlewares;
- Integrated Multipart form processing;
- Support WebSocket;
- Acme support, automatically get TLS certificate from let's encrypt.
⚡️ Quick start
You can view samples here, or view offical website.
Create a new rust project:
Add this to Cargo.toml
[]
= "*"
= { = "1", = ["macros"] }
Create a simple function handler in the main.rs file, we call it hello_world
, this function just render plain text "Hello World"
.
use *;
async
In the main
function, we need to create a root Router first, and then create a server and call it's bind
function:
use *;
async
async
Middleware
There is no difference between Handler and Middleware, Middleware is just Handler. So you can write middlewares without to know concpets like associated type, generic type. You can write middleware if you can write function!!!
use ;
use *;
async
Then add it to router:
.hoop.get
new
This is a very simple middleware, it add Header
to Response
, view full source code.
Chainable tree routing system
Normally we write routing like this:
.get.post;
with_path
.get
.patch
.delete;
with_path
Often viewing articles and article lists does not require user login, but creating, editing, deleting articles, etc. require user login authentication permissions. The tree-like routing system in Salvo can meet this demand. We can write routers without user login together:
.get
.push;
with_path
Then write the routers that require the user to login together, and use the corresponding middleware to verify whether the user is logged in:
.hoop
.post
.push;
with_path
Although these two routes have the same path("articles")
, they can still be added to the same parent route at the same time, so the final route looks like this:
.push
.push;
new
<id>
matches a fragment in the path, under normal circumstances, the article id
is just a number, which we can use regular expressions to restrict id
matching rules, r"<id:/\d+/>"
.
You can also use <*>
or <**>
to match all remaining path fragments. In order to make the code more readable, you can also add appropriate name to make the path semantics more clear, for example: <**file_path>
.
Some regular expressions for matching paths need to be used frequently, and it can be registered in advance, such as GUID:
;
register_wisp_regex
This makes it more concise when path matching is required:
.get
with_path
View full source code
File upload
We can get file async by the function file
in Request
:
async
Extract data from request
You can easily get data from multiple different data sources and assemble it into the type you want. You can define a custom type first, for example:
/// Get the data field value from the body by default.
Then in Handler
you can get the data like this:
async
You can even pass the type directly to the function as a parameter, like this:
async
There is considerable flexibility in the definition of data types, and can even be resolved into nested structures as needed:
View full source code
More Examples
Your can find more examples in examples folder. You can run these examples with the following command:
cargo run --bin example-basic-auth
You can use any example name you want to run instead of basic-auth
here.
🚀 Performance
Benchmark testing result can be found from here:
https://web-frameworks-benchmark.netlify.app/result?l=rust
https://www.techempower.com/benchmarks/#section=data-r21
🎇 Deployment
You can deploy your salvo projects through shuttle.rs, it is very easy, you can read shuttle's offical document here.
🩸 Contributing
Contributions are absolutely, positively welcome and encouraged! Contributions come in many forms. You could:
- Submit a feature request or bug report as an issue;
- Comment on issues that require feedback;
- Contribute code via pull requests;
- Publish Salvo-related technical articles on blogs or technical platforms。
All pull requests are code reviewed and tested by the CI. Note that unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Salvo by you shall be dual licensed under the MIT License, without any additional terms or conditions.
☕ 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)