2022-02-01 00:30:41 +00:00
< div align = "center" >
< h1 > Actix Web< / h1 >
< p >
< strong > Actix Web is a powerful, pragmatic, and extremely fast web framework for Rust< / strong >
< / p >
< p >
2023-08-03 05:28:45 +00:00
<!-- prettier - ignore - start -->
[](https://crates.io/crates/actix-web)
2024-08-10 02:21:55 +00:00
[](https://docs.rs/actix-web/4.9.0)
2024-02-13 01:24:34 +00:00
2023-08-03 05:28:45 +00:00
2024-08-10 02:21:55 +00:00
[](https://deps.rs/crate/actix-web/4.9.0)
2023-08-03 05:28:45 +00:00
< br / >
[](https://github.com/actix/actix-web/actions/workflows/ci.yml)
[](https://codecov.io/gh/actix/actix-web)
[](https://discord.gg/NWpN5mmg3x)
<!-- prettier - ignore - end -->
2022-02-01 00:30:41 +00:00
< / p >
< / div >
## Features
- Supports _HTTP/1.x_ and _HTTP/2_
- Streaming and pipelining
- Powerful [request routing ](https://actix.rs/docs/url-dispatch/ ) with optional macros
- Full [Tokio ](https://tokio.rs ) compatibility
- Keep-alive and slow requests handling
- Client/server [WebSockets ](https://actix.rs/docs/websockets/ ) support
- Transparent content compression/decompression (br, gzip, deflate, zstd)
- Multipart streams
- Static assets
- SSL support using OpenSSL or Rustls
- Middlewares ([Logger, Session, CORS, etc](https://actix.rs/docs/middleware/))
2022-02-08 10:21:47 +00:00
- Integrates with the [`awc` HTTP client ](https://docs.rs/awc/ )
2024-02-13 01:24:34 +00:00
- Runs on stable Rust 1.72+
2022-02-01 00:30:41 +00:00
## Documentation
- [Website & User Guide ](https://actix.rs )
- [Examples Repository ](https://github.com/actix/examples )
- [API Documentation ](https://docs.rs/actix-web )
- [API Documentation (master branch) ](https://actix.rs/actix-web/actix_web )
## Example
Dependencies:
```toml
[dependencies]
2022-02-25 20:36:16 +00:00
actix-web = "4"
2022-02-01 00:30:41 +00:00
```
Code:
```rust
use actix_web::{get, web, App, HttpServer, Responder};
2022-03-05 23:15:33 +00:00
#[get("/hello/{name}")]
async fn greet(name: web::Path< String > ) -> impl Responder {
format!("Hello {name}!")
2022-02-01 00:30:41 +00:00
}
#[actix_web::main] // or #[tokio::main]
async fn main() -> std::io::Result< ()> {
2022-03-05 23:15:33 +00:00
HttpServer::new(|| {
App::new().service(greet)
})
.bind(("127.0.0.1", 8080))?
.run()
.await
2022-02-01 00:30:41 +00:00
}
```
2022-02-18 03:41:10 +00:00
### More Examples
- [Hello World ](https://github.com/actix/examples/tree/master/basics/hello-world )
- [Basic Setup ](https://github.com/actix/examples/tree/master/basics/basics )
- [Application State ](https://github.com/actix/examples/tree/master/basics/state )
- [JSON Handling ](https://github.com/actix/examples/tree/master/json/json )
- [Multipart Streams ](https://github.com/actix/examples/tree/master/forms/multipart )
2022-06-15 21:38:10 +00:00
- [MongoDB Integration ](https://github.com/actix/examples/tree/master/databases/mongodb )
2022-02-18 03:41:10 +00:00
- [Diesel Integration ](https://github.com/actix/examples/tree/master/databases/diesel )
- [SQLite Integration ](https://github.com/actix/examples/tree/master/databases/sqlite )
- [Postgres Integration ](https://github.com/actix/examples/tree/master/databases/postgres )
- [Tera Templates ](https://github.com/actix/examples/tree/master/templating/tera )
- [Askama Templates ](https://github.com/actix/examples/tree/master/templating/askama )
- [HTTPS using Rustls ](https://github.com/actix/examples/tree/master/https-tls/rustls )
- [HTTPS using OpenSSL ](https://github.com/actix/examples/tree/master/https-tls/openssl )
- [Simple WebSocket ](https://github.com/actix/examples/tree/master/websockets )
- [WebSocket Chat ](https://github.com/actix/examples/tree/master/websockets/chat )
You may consider checking out [this directory ](https://github.com/actix/examples/tree/master ) for more examples.
2022-02-01 00:30:41 +00:00
## Benchmarks
2023-06-09 13:29:10 +00:00
One of the fastest web frameworks available according to the [TechEmpower Framework Benchmark ](https://www.techempower.com/benchmarks/#section=data-r21&test=composite ).
2022-02-01 00:30:41 +00:00
## License
This project is licensed under either of the following licenses, at your option:
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0])
- MIT license ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT])
## Code of Conduct
2024-06-10 23:36:46 +00:00
Contribution to the `actix/actix-web` repo is organized under the terms of the Contributor Covenant. The Actix team promises to intervene to uphold that code of conduct.
