README.md
1<div align="center">
2 <h1>Actix Web</h1>
3 <p>
4 <strong>Actix Web is a powerful, pragmatic, and extremely fast web framework for Rust</strong>
5 </p>
6 <p>
7
8[](https://crates.io/crates/actix-web)
9[](https://docs.rs/actix-web/4.0.0-beta.8)
10[](https://blog.rust-lang.org/2020/03/12/Rust-1.46.html)
11
12[](https://deps.rs/crate/actix-web/4.0.0-beta.8)
13<br />
14[](https://github.com/actix/actix-web/actions)
15[](https://codecov.io/gh/actix/actix-web)
16
17[](https://discord.gg/NWpN5mmg3x)
18
19 </p>
20</div>
21
22## Features
23
24* Supports *HTTP/1.x* and *HTTP/2*
25* Streaming and pipelining
26* Keep-alive and slow requests handling
27* Client/server [WebSockets](https://actix.rs/docs/websockets/) support
28* Transparent content compression/decompression (br, gzip, deflate, zstd)
29* Powerful [request routing](https://actix.rs/docs/url-dispatch/)
30* Multipart streams
31* Static assets
32* SSL support using OpenSSL or Rustls
33* Middlewares ([Logger, Session, CORS, etc](https://actix.rs/docs/middleware/))
34* Includes an async [HTTP client](https://docs.rs/awc/)
35* Runs on stable Rust 1.46+
36
37## Documentation
38
39* [Website & User Guide](https://actix.rs)
40* [Examples Repository](https://github.com/actix/examples)
41* [API Documentation](https://docs.rs/actix-web)
42* [API Documentation (master branch)](https://actix.rs/actix-web/actix_web)
43
44## Example
45
46Dependencies:
47
48```toml
49[dependencies]
50actix-web = "3"
51```
52
53Code:
54
55```rust
56use actix_web::{get, web, App, HttpServer, Responder};
57
58#[get("/{id}/{name}/index.html")]
59async fn index(web::Path((id, name)): web::Path<(u32, String)>) -> impl Responder {
60 format!("Hello {}! id:{}", name, id)
61}
62
63#[actix_web::main]
64async fn main() -> std::io::Result<()> {
65 HttpServer::new(|| App::new().service(index))
66 .bind("127.0.0.1:8080")?
67 .run()
68 .await
69}
70```
71
72### More examples
73
74* [Basic Setup](https://github.com/actix/examples/tree/master/basics/basics/)
75* [Application State](https://github.com/actix/examples/tree/master/basics/state/)
76* [JSON Handling](https://github.com/actix/examples/tree/master/json/json/)
77* [Multipart Streams](https://github.com/actix/examples/tree/master/forms/multipart/)
78* [Diesel Integration](https://github.com/actix/examples/tree/master/database_interactions/diesel/)
79* [r2d2 Integration](https://github.com/actix/examples/tree/master/database_interactions/r2d2/)
80* [Simple WebSocket](https://github.com/actix/examples/tree/master/websockets/websocket/)
81* [Tera Templates](https://github.com/actix/examples/tree/master/template_engines/tera/)
82* [Askama Templates](https://github.com/actix/examples/tree/master/template_engines/askama/)
83* [HTTPS using Rustls](https://github.com/actix/examples/tree/master/security/rustls/)
84* [HTTPS using OpenSSL](https://github.com/actix/examples/tree/master/security/openssl/)
85* [WebSocket Chat](https://github.com/actix/examples/tree/master/websockets/chat/)
86
87You may consider checking out
88[this directory](https://github.com/actix/examples/tree/master/) for more examples.
89
90## Benchmarks
91
92One of the fastest web frameworks available according to the
93[TechEmpower Framework Benchmark](https://www.techempower.com/benchmarks/#section=data-r20&test=composite).
94
95## License
96
97This project is licensed under either of
98
99* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
100 [http://www.apache.org/licenses/LICENSE-2.0])
101* MIT license ([LICENSE-MIT](LICENSE-MIT) or
102 [http://opensource.org/licenses/MIT])
103
104at your option.
105
106## Code of Conduct
107
108Contribution to the actix-web repo is organized under the terms of the Contributor Covenant.
109The Actix team promises to intervene to uphold that code of conduct.
110
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}