2019-12-06 06:22:29 +00:00
< div align = "center" >
2021-02-10 12:12:03 +00:00
< h1 > Actix Web< / h1 >
2020-07-05 00:16:53 +00:00
< p >
2020-11-29 16:33:45 +00:00
< strong > Actix Web is a powerful, pragmatic, and extremely fast web framework for Rust< / strong >
2020-07-05 00:16:53 +00:00
< / p >
2019-12-06 06:22:29 +00:00
< p >
2020-10-30 03:15:22 +00:00
[](https://crates.io/crates/actix-web)
2022-01-31 22:23:33 +00:00
[](https://docs.rs/actix-web/4.0.0-rc.1)
2022-01-05 04:24:40 +00:00
2021-02-10 12:10:03 +00:00
2022-01-31 22:23:33 +00:00
[](https://deps.rs/crate/actix-web/4.0.0-rc.1)
2020-07-05 00:16:53 +00:00
< br / >
2021-12-31 07:53:53 +00:00
[](https://github.com/actix/actix-web/actions/workflows/ci.yml)
2022-01-05 04:24:40 +00:00
[](https://codecov.io/gh/actix/actix-web)
2021-02-07 03:54:58 +00:00
2020-10-30 03:15:22 +00:00
[](https://discord.gg/NWpN5mmg3x)
2019-12-08 13:27:06 +00:00
2019-12-06 06:22:29 +00:00
< / p >
< / div >
2017-09-30 16:16:59 +00:00
2020-07-05 00:16:53 +00:00
## Features
2017-12-05 20:25:57 +00:00
2022-01-31 22:20:53 +00:00
- Supports _HTTP/1.x_ and _HTTP/2_
2021-12-22 08:21:30 +00:00
- Streaming and pipelining
2022-01-31 22:20:53 +00:00
- Powerful [request routing ](https://actix.rs/docs/url-dispatch/ ) with optional macros
- Full [Tokio ](https://tokio.rs ) compatibility
2021-12-22 08:21:30 +00:00
- 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/))
- Includes an async [HTTP client ](https://docs.rs/awc/ )
2021-12-29 08:59:15 +00:00
- Runs on stable Rust 1.54+
2017-11-04 19:36:37 +00:00
2020-07-05 00:16:53 +00:00
## Documentation
2020-04-07 19:48:01 +00:00
2021-12-22 08:21:30 +00:00
- [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 )
2020-04-07 19:48:01 +00:00
2018-01-31 14:34:50 +00:00
## Example
2020-01-16 14:17:17 +00:00
Dependencies:
```toml
[dependencies]
2022-01-31 22:20:53 +00:00
actix-web = "4.0.0-rc.1"
2020-01-16 14:17:17 +00:00
```
Code:
2018-03-12 16:13:04 +00:00
```rust
2019-12-12 01:06:22 +00:00
use actix_web::{get, web, App, HttpServer, Responder};
2018-01-31 14:34:50 +00:00
2019-11-26 10:07:39 +00:00
#[get("/{id}/{name}/index.html")]
2022-01-31 22:20:53 +00:00
async fn index(params: web::Path< (u32, String)>) -> impl Responder {
let (id, name) = params.into_inner();
2020-07-20 23:54:26 +00:00
format!("Hello {}! id:{}", name, id)
2018-01-31 14:34:50 +00:00
}
2022-01-31 22:20:53 +00:00
#[actix_web::main] // or #[tokio::main]
2019-11-26 11:16:33 +00:00
async fn main() -> std::io::Result< ()> {
2019-11-26 10:07:39 +00:00
HttpServer::new(|| App::new().service(index))
2022-01-31 22:20:53 +00:00
.bind(("127.0.0.1", 8080))?
2019-12-22 13:16:07 +00:00
.run()
2019-11-26 11:16:33 +00:00
.await
2018-01-31 14:34:50 +00:00
}
```
2017-12-15 04:12:28 +00:00
2018-01-31 14:34:50 +00:00
### More examples
2017-10-07 07:53:36 +00:00
2021-12-22 08:21:30 +00:00
- [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/ )
- [Diesel Integration ](https://github.com/actix/examples/tree/master/database_interactions/diesel/ )
- [r2d2 Integration ](https://github.com/actix/examples/tree/master/database_interactions/r2d2/ )
- [Simple WebSocket ](https://github.com/actix/examples/tree/master/websockets/websocket/ )
- [Tera Templates ](https://github.com/actix/examples/tree/master/template_engines/tera/ )
- [Askama Templates ](https://github.com/actix/examples/tree/master/template_engines/askama/ )
- [HTTPS using Rustls ](https://github.com/actix/examples/tree/master/security/rustls/ )
- [HTTPS using OpenSSL ](https://github.com/actix/examples/tree/master/security/openssl/ )
- [WebSocket Chat ](https://github.com/actix/examples/tree/master/websockets/chat/ )
2017-10-21 09:08:07 +00:00
2022-01-31 22:20:53 +00:00
You may consider checking out [this directory ](https://github.com/actix/examples/tree/master/ ) for more examples.
2018-03-01 06:31:54 +00:00
2018-01-31 14:34:50 +00:00
## Benchmarks
2022-01-31 22:20:53 +00:00
One of the fastest web frameworks available according to the [TechEmpower Framework Benchmark ](https://www.techempower.com/benchmarks/#section=data-r20&test=composite ).
2018-02-15 17:53:09 +00:00
2017-12-05 20:25:57 +00:00
## License
2017-10-21 09:08:07 +00:00
2022-01-31 22:20:53 +00:00
This project is licensed under either of the following licenses, at your option:
2017-12-19 00:48:30 +00:00
2022-01-31 22:20:53 +00:00
- 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])
2018-01-21 23:29:02 +00:00
## Code of Conduct
2020-12-31 03:24:18 +00:00
Contribution to the actix-web repo is organized under the terms of the Contributor Covenant.
The Actix team promises to intervene to uphold that code of conduct.
