2017-10-24 00:58:05 +02:00
|
|
|
# Actix web [![Build Status](https://travis-ci.org/actix/actix-web.svg?branch=master)](https://travis-ci.org/actix/actix-web) [![Build status](https://ci.appveyor.com/api/projects/status/kkdb4yce7qhm5w85/branch/master?svg=true)](https://ci.appveyor.com/project/fafhrd91/actix-web-hdy9d/branch/master) [![codecov](https://codecov.io/gh/actix/actix-web/branch/master/graph/badge.svg)](https://codecov.io/gh/actix/actix-web) [![crates.io](http://meritbadge.herokuapp.com/actix-web)](https://crates.io/crates/actix-web)
|
2017-09-30 18:16:59 +02:00
|
|
|
|
2017-12-05 21:25:57 +01:00
|
|
|
Actix web is a small, fast, down-to-earth, open source rust web framework.
|
|
|
|
|
|
|
|
```rust,ignore
|
|
|
|
use actix_web::*;
|
|
|
|
|
|
|
|
fn index(req: HttpRequest) -> String {
|
|
|
|
format!("Hello {}!", &req.match_info()["name"])
|
|
|
|
}
|
|
|
|
|
|
|
|
fn main() {
|
|
|
|
HttpServer::new(
|
2017-12-06 20:00:39 +01:00
|
|
|
Application::new("/")
|
2017-12-05 21:25:57 +01:00
|
|
|
.resource("/{name}", |r| r.method(Method::GET).f(index)))
|
|
|
|
.serve::<_, ()>("127.0.0.1:8080");
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Documentation
|
2017-09-30 18:16:59 +02:00
|
|
|
|
2017-11-28 04:56:14 +01:00
|
|
|
* [User Guide](http://actix.github.io/actix-web/guide/)
|
2017-10-24 00:58:05 +02:00
|
|
|
* [API Documentation (Development)](http://actix.github.io/actix-web/actix_web/)
|
|
|
|
* [API Documentation (Releases)](https://docs.rs/actix-web/)
|
2017-10-31 00:37:26 +01:00
|
|
|
* Cargo package: [actix-web](https://crates.io/crates/actix-web)
|
2017-10-07 08:14:13 +02:00
|
|
|
* Minimum supported Rust version: 1.20 or later
|
2017-09-30 18:16:59 +02:00
|
|
|
|
2017-10-07 10:12:43 +02:00
|
|
|
## Features
|
|
|
|
|
2017-11-04 21:49:05 +01:00
|
|
|
* Supported HTTP/1 and HTTP/2 protocols
|
2017-11-04 20:33:14 +01:00
|
|
|
* Streaming and pipelining
|
|
|
|
* Keep-alive and slow requests handling
|
|
|
|
* [WebSockets](https://actix.github.io/actix-web/actix_web/ws/index.html)
|
2017-11-09 04:42:13 +01:00
|
|
|
* Transparent content compression/decompression (br, gzip, deflate)
|
2017-10-23 18:17:24 +02:00
|
|
|
* Configurable request routing
|
2017-10-21 11:08:07 +02:00
|
|
|
* Multipart streams
|
2017-11-27 07:20:28 +01:00
|
|
|
* Middlewares (Logger, Session included)
|
2017-12-05 21:25:57 +01:00
|
|
|
* Built on top of [Actix](https://github.com/actix/actix).
|
2017-11-04 20:36:37 +01:00
|
|
|
|
2017-11-04 20:35:19 +01:00
|
|
|
## HTTP/2
|
|
|
|
|
|
|
|
Actix web automatically upgrades connection to `http/2` if possible.
|
|
|
|
|
|
|
|
### Negotiation
|
2017-11-04 20:33:14 +01:00
|
|
|
|
2017-11-09 01:48:20 +01:00
|
|
|
`HTTP/2` protocol over tls without prior knowlage requires
|
2017-11-04 20:35:55 +01:00
|
|
|
[tls alpn](https://tools.ietf.org/html/rfc7301). At the moment only
|
2017-11-04 21:49:05 +01:00
|
|
|
`rust-openssl` supports alpn.
|
2017-11-04 20:33:14 +01:00
|
|
|
|
|
|
|
```toml
|
|
|
|
[dependencies]
|
|
|
|
actix-web = { git = "https://github.com/actix/actix-web", features=["alpn"] }
|
|
|
|
```
|
|
|
|
|
2017-11-04 21:49:05 +01:00
|
|
|
Upgrade to `http/2` schema described in
|
2017-11-04 21:49:51 +01:00
|
|
|
[rfc section 3.2](https://http2.github.io/http2-spec/#rfc.section.3.2) is not supported.
|
2017-11-04 21:49:05 +01:00
|
|
|
Starting `http/2` with prior knowledge is supported for both clear text connection
|
2017-11-04 21:49:51 +01:00
|
|
|
and tls connection. [rfc section 3.4](https://http2.github.io/http2-spec/#rfc.section.3.4)
|
2017-11-04 21:49:05 +01:00
|
|
|
|
2017-11-09 05:25:14 +01:00
|
|
|
[tls example](https://github.com/actix/actix-web/tree/master/examples/tls)
|
|
|
|
|
2017-12-05 21:25:57 +01:00
|
|
|
## Examples
|
2017-10-07 09:53:36 +02:00
|
|
|
|
2017-10-23 18:20:12 +02:00
|
|
|
* [Basic](https://github.com/actix/actix-web/tree/master/examples/basic.rs)
|
2017-10-23 20:48:06 +02:00
|
|
|
* [Stateful](https://github.com/actix/actix-web/tree/master/examples/state.rs)
|
2017-10-23 18:20:12 +02:00
|
|
|
* [Mulitpart streams](https://github.com/actix/actix-web/tree/master/examples/multipart)
|
|
|
|
* [Simple websocket session](https://github.com/actix/actix-web/tree/master/examples/websocket.rs)
|
2017-10-23 18:16:13 +02:00
|
|
|
* [Tcp/Websocket chat](https://github.com/actix/actix-web/tree/master/examples/websocket-chat)
|
2017-11-04 17:07:44 +01:00
|
|
|
* [SockJS Server](https://github.com/actix/actix-sockjs)
|
2017-10-21 11:08:07 +02:00
|
|
|
|
2017-12-05 21:25:57 +01:00
|
|
|
## License
|
2017-10-21 11:08:07 +02:00
|
|
|
|
2017-12-05 21:25:57 +01:00
|
|
|
Actix web is licensed under the [Apache-2.0 license](http://opensource.org/licenses/APACHE-2.0).
|