2019-12-06 06:22:29 +00:00
< div align = "center" >
2020-07-05 00:16:53 +00:00
< h1 > Actix web< / h1 >
< 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)
2020-12-01 22:22:46 +00:00
[](https://docs.rs/actix-web/3.3.2)
2020-07-21 07:40:30 +00:00
[](https://blog.rust-lang.org/2020/03/12/Rust-1.42.html)
2019-12-06 06:22:29 +00:00
2020-12-01 22:22:46 +00:00
[](https://deps.rs/crate/actix-web/3.3.2)
2020-07-05 00:16:53 +00:00
< br / >
[](https://travis-ci.org/actix/actix-web)
[](https://codecov.io/gh/actix/actix-web)
[](https://crates.io/crates/actix-web)
[](https://gitter.im/actix/actix?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
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
2020-07-05 00:16:53 +00:00
* Supports *HTTP/1.x* and *HTTP/2*
2017-12-30 15:07:39 +00:00
* Streaming and pipelining
* Keep-alive and slow requests handling
2018-05-23 18:20:12 +00:00
* Client/server [WebSockets ](https://actix.rs/docs/websockets/ ) support
2017-12-30 15:07:39 +00:00
* Transparent content compression/decompression (br, gzip, deflate)
2020-07-05 00:16:53 +00:00
* Powerful [request routing ](https://actix.rs/docs/url-dispatch/ )
2017-12-30 15:07:39 +00:00
* Multipart streams
2018-03-09 13:42:42 +00:00
* Static assets
2020-07-05 00:16:53 +00:00
* SSL support using OpenSSL or Rustls
2019-06-05 03:02:44 +00:00
* Middlewares ([Logger, Session, CORS, etc](https://actix.rs/docs/middleware/))
2020-07-05 00:16:53 +00:00
* Includes an async [HTTP client ](https://actix.rs/actix-web/actix_web/client/index.html )
2019-03-24 04:29:16 +00:00
* Supports [Actix actor framework ](https://github.com/actix/actix )
2020-07-21 07:40:30 +00:00
* Runs on stable Rust 1.42+
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
2020-07-05 00:16:53 +00:00
* [Website & User Guide ](https://actix.rs )
2020-09-09 23:12:50 +00:00
* [Examples Repository ](https://github.com/actix/examples )
2020-07-05 00:16:53 +00:00
* [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]
2020-07-05 00:16:53 +00:00
actix-web = "3"
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")]
2020-07-20 23:54:26 +00:00
async fn index(web::Path((id, name)): web::Path< (u32, String)>) -> impl Responder {
format!("Hello {}! id:{}", name, id)
2018-01-31 14:34:50 +00:00
}
2020-06-18 14:45:30 +00:00
#[actix_web::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))
2019-03-24 04:29:16 +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
2020-07-05 00:16:53 +00:00
* [Basic Setup ](https://github.com/actix/examples/tree/master/basics/ )
* [Application State ](https://github.com/actix/examples/tree/master/state/ )
* [JSON Handling ](https://github.com/actix/examples/tree/master/json/ )
* [Multipart Streams ](https://github.com/actix/examples/tree/master/multipart/ )
* [Diesel Integration ](https://github.com/actix/examples/tree/master/diesel/ )
* [r2d2 Integration ](https://github.com/actix/examples/tree/master/r2d2/ )
* [Simple WebSocket ](https://github.com/actix/examples/tree/master/websocket/ )
* [Tera Templates ](https://github.com/actix/examples/tree/master/template_tera/ )
* [Askama Templates ](https://github.com/actix/examples/tree/master/template_askama/ )
* [HTTPS using Rustls ](https://github.com/actix/examples/tree/master/rustls/ )
* [HTTPS using OpenSSL ](https://github.com/actix/examples/tree/master/openssl/ )
* [WebSocket Chat ](https://github.com/actix/examples/tree/master/websocket-chat/ )
2017-10-21 09:08:07 +00:00
2018-03-01 06:31:54 +00:00
You may consider checking out
2018-04-13 03:31:58 +00:00
[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
2020-07-05 00:16:53 +00:00
One of the fastest web frameworks available according to the
[TechEmpower Framework Benchmark ](https://www.techempower.com/benchmarks/#section=data-r19 ).
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
2017-12-19 00:48:30 +00:00
This project is licensed under either of
2020-07-05 00:16:53 +00:00
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
[http://www.apache.org/licenses/LICENSE-2.0 ](http://www.apache.org/licenses/LICENSE-2.0 ))
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
[http://opensource.org/licenses/MIT ](http://opensource.org/licenses/MIT ))
2017-12-19 00:48:30 +00:00
at your option.
2018-01-21 23:29:02 +00:00
## Code of Conduct
2020-07-05 00:16:53 +00:00
Contribution to the actix-web crate is organized under the terms of the Contributor Covenant, the
maintainers of Actix web, promises to intervene to uphold that code of conduct.
