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 1 and Tokio;
- HTTP1, HTTP2 and HTTP3;
- Unified middleware and handle interface;
- Router can be nested infinitely, and multiple middlewares can be attached to any router;
- Integrated Multipart form processing;
- Support WebSocket, WebTransport;
- Support OpenAPI, generate OpenAPI data automatic;
- Support Acme, automatically get TLS certificate from let's encrypt;
- Support Tower Service and Layer;
⚡️ Quick Start
You can view samples here, or view official website.
Hello World with ACME and HTTP3
It only takes a few lines of code to implement a server that supports ACME to automatically obtain certificates and supports HTTP1, HTTP2, and HTTP3 protocols.
use salvo::prelude::*; #[handler] async fn hello(res: &mut Response) { res.render(Text::Plain("Hello World")); } #[tokio::main] async fn main() { let mut router = Router::new().get(hello); let listener = TcpListener::new("0.0.0.0:443") .acme() .add_domain("test.salvo.rs") // Replace this domain name with your own. .http01_challege(&mut router).quinn("0.0.0.0:443"); let acceptor = listener.join(TcpListener::new("0.0.0.0:80")).bind().await; Server::new(acceptor).serve(router).await; }
Middleware
There is no difference between Handler and Middleware, Middleware is just Handler. So you can write middlewares without to know concepts like associated type, generic type. You can write middleware if you can write function!!!
use salvo::http::header::{self, HeaderValue}; use salvo::prelude::*; #[handler] async fn add_header(res: &mut Response) { res.headers_mut() .insert(header::SERVER, HeaderValue::from_static("Salvo")); }
Then add it to router:
Router::new().hoop(add_header).get(hello)
This is a very simple middleware, it adds Header to Response, view full source code.
Chainable tree routing system
Normally we write routing like this：
Router::with_path("articles").get(list_articles).post(create_article); Router::with_path("articles/<id>") .get(show_article) .patch(edit_article) .delete(delete_article);
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:
Router::with_path("articles") .get(list_articles) .push(Router::with_path("<id>").get(show_article));
Then write the routers that require the user to login together, and use the corresponding middleware to verify whether the user is logged in:
Router::with_path("articles") .hoop(auth_check) .push(Router::with_path("<id>").patch(edit_article).delete(delete_article));
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:
Router::new() .push( Router::with_path("articles") .get(list_articles) .push(Router::with_path("<id>").get(show_article)), ) .push( Router::with_path("articles") .hoop(auth_check) .push(Router::with_path("<id>").patch(edit_article).delete(delete_article)), );
<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:
PathFilter::register_wisp_regex( "guid", Regex::new("[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}").unwrap(), );
This makes it more concise when path matching is required:
Router::with_path("<id:guid>").get(index)
View full source code
File upload
We can get file async by the function file in Request:
#[handler] async fn upload(req: &mut Request, res: &mut Response) { let file = req.file("file").await; if let Some(file) = file { let dest = format!("temp/{}", file.name().unwrap_or_else(|| "file".into())); if let Err(e) = tokio::fs::copy(&file.path, Path::new(&dest)).await { res.status_code(StatusCode::INTERNAL_SERVER_ERROR); } else { res.render("Ok"); } } else { res.status_code(StatusCode::BAD_REQUEST); } }
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:
#[derive(Serialize, Deserialize, Extractible, Debug)] /// Get the data field value from the body by default. #[salvo(extract(default_source(from = "body")))] struct GoodMan<'a> { /// The id number is obtained from the request path parameter, and the data is automatically parsed as i64 type. #[salvo(extract(source(from = "param")))] id: i64, /// Reference types can be used to avoid memory copying. username: &'a str, first_name: String, last_name: String, }
Then in Handler you can get the data like this:
#[handler] async fn edit(req: &mut Request) { let good_man: GoodMan<'_> = req.extract().await.unwrap(); }
You can even pass the type directly to the function as a parameter, like this:
#[handler] async fn edit<'a>(good_man: GoodMan<'a>) { res.render(Json(good_man)); }
View full source code
OpenAPI Supported
Perfect support for OpenAPI can be achieved without making significant changes to the project.
#[derive(Serialize, Deserialize, ToSchema, Debug)] struct MyObject<T: ToSchema + std::fmt::Debug> { value: T, } #[endpoint] async fn use_string(body: JsonBody<MyObject<String>>) -> String { format!("{:?}", body) } #[endpoint] async fn use_i32(body: JsonBody<MyObject<i32>>) -> String { format!("{:?}", body) } #[endpoint] async fn use_u64(body: JsonBody<MyObject<u64>>) -> String { format!("{:?}", body) } #[tokio::main] async fn main() { tracing_subscriber::fmt().init(); let router = Router::new() .push(Router::with_path("i32").post(use_i32)) .push(Router::with_path("u64").post(use_u64)) .push(Router::with_path("string").post(use_string)); let doc = OpenApi::new("test api", "0.0.1").merge_router(&router); let router = router .push(doc.into_router("/api-doc/openapi.json")) .push(SwaggerUi::new("/api-doc/openapi.json").into_router("swagger-ui")); let acceptor = TcpListener::new("127.0.0.1:5800").bind().await; Server::new(acceptor).serve(router).await; }
🛠️ Salvo CLI
Salvo CLI is a command-line tool that simplifies the creation of new Salvo projects, supporting templates for web APIs, websites, databases (including SQLite, PostgreSQL, and MySQL via SQLx, SeaORM, Diesel, Rbatis), and basic middleware. You can use salvo-cli to create a new Salvo project:
install
cargo install salvo-cli
create a new salvo project
salvo new project_name
More Examples
Your can find more examples in examples folder. You can run these examples with the following command:
cd examples 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-r22
🩸 Contributors
<a href="https://github.com/salvo-rs/salvo/graphs/contributors"> <img src="https://contrib.rocks/image?repo=salvo-rs/salvo" /> </a>☕ Donate
Salvo is an open source project. If you want to support Salvo, you can ☕ buy me 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
编辑推荐精选
堆友
多风格AI绘画神器
堆友平台由阿里巴巴设计团队创建，作为一款AI驱动的设计工具，专为设计师提供一站式增长服务。功能覆盖海量3D素材、AI绘画、实时渲染以及专业抠图，显著提升设计品质和效率。平台不仅提供工具，还是一个促进创意交流和个人发展的空间，界面友好，适合所有级别的设计师和创意工作者。
码上飞
零代码AI应用开发平台
零代码AI应用开发平台，用户只需一句话简单描述需求，AI能自动生成小程序、APP或H5网页应用，无需编写代码。
Vora
免费创建高清无水印Sora视频
Vora是一个免费创建高清无水印Sora视频的AI工具
Refly.AI
最适合小白的AI自动化工作流平台
无需编码，轻松生成可复用、可变现的AI自动化工作流
酷表ChatExcel
大模型驱动的Excel数据处理工具
基于大模型交互的表格处理系统，允许用户通过对话方式完成数据整理和可视化分析。系统采用机器学习算法解析用户指令，自动执行排序、公式计算和数据透视等操作，支持多种文件格式导入导出。数据处理响应速度保持在0.8秒以内，支持超过100万行数据的即时分析。
TRAE编程
AI辅助编程，代码自动修复
Trae是一种自适应的集成开发环境（IDE），通过自动化和多元协作改变开发流程。利用Trae，团队能够更快速、精确地编写和部署代码，从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能，是提升开发效率的理想工具。
AIWritePaper论文写作
AI论文写作指导平台
AIWritePaper论文写作是一站式AI论文写作辅助工具，简化了选题、文献检索至论文撰写的整个过程。通过简单设定，平台可快速生成高质量论文大纲和全文，配合图表、参考文献等一应俱全，同时提供开题报告和答辩PPT等增值服务，保障数据安全，有效提升写作效率和论文质量。
博思AIPPT
AI一键生成PPT，就用博思AIPPT！
博思AIPPT，新一代的AI生成PPT平台，支持智能生成PPT、AI美化PPT、文本&链接生成PPT、导入Word/PDF/Markdown文档生成PPT等，内置海量精美PPT模板，涵盖商务、教育、科技等不同风格 ，同时针对每个页面提供多种版式，一键自适应切换，完美适配各种办公场景。
潮际好麦
AI赋能电商视觉革命，一站式智能商拍平台
潮际好麦深耕服装行业，是国内AI试衣效果最好的软件。使用先进AIGC能力为电商卖家批量提供优质的、低成本的商拍图。合作品牌有Shein、Lazada、安踏、百丽等65个国内外头部品牌，以及国内10万+淘宝、天猫、京东等主流平台的品牌商家，为卖家节省将近85%的出图成本，提升约3倍出图效率，让品牌能够快速上架。
iTerms
企业专属的AI法律顾问
iTerms是法大大集团旗下法律子品牌，基于最先进的大语言模型(LLM)、专业的法律知识库和强大的智能体架构，帮助企业扫清合规障碍，筑牢风控防线，成为您企业专属的AI法律顾问。
推荐工具精选
AI云服务特惠
懂AI专属折扣关注微信公众号
最新AI工具、AI资讯
独家AI资源、AI项目落地
微信扫一扫关注公众号