2017-10-23 17:05:07 +00:00
|
|
|
# Actix web [](https://travis-ci.org/actix/actix-web) [](https://ci.appveyor.com/project/fafhrd91/actix-web-hdy9d/branch/master) [](https://codecov.io/gh/actix/actix-web)
|
2017-09-30 16:16:59 +00:00
|
|
|
|
2017-10-23 16:16:13 +00:00
|
|
|
Web framework for [Actix](https://github.com/actix/actix).
|
2017-09-30 16:16:59 +00:00
|
|
|
|
2017-10-23 16:16:13 +00:00
|
|
|
* [API Documentation](http://actix.github.io/actix-web/actix_web/)
|
2017-10-15 06:00:03 +00:00
|
|
|
* Cargo package: [actix-http](https://crates.io/crates/actix-web)
|
2017-10-07 06:14:13 +00:00
|
|
|
* Minimum supported Rust version: 1.20 or later
|
2017-09-30 16:16:59 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2017-10-16 17:43:35 +00:00
|
|
|
Actix web is licensed under the [Apache-2.0 license](http://opensource.org/licenses/APACHE-2.0).
|
2017-09-30 16:16:59 +00:00
|
|
|
|
2017-10-07 08:12:43 +00:00
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
* HTTP 1.1 and 1.0 support
|
|
|
|
|
* Streaming and pipelining support
|
2017-10-13 23:33:23 +00:00
|
|
|
* Keep-alive and slow requests support
|
2017-10-23 16:16:13 +00:00
|
|
|
* [WebSockets support](https://actix.github.io/actix-web/actix_web/ws/index.html)
|
2017-10-23 16:17:24 +00:00
|
|
|
* Configurable request routing
|
2017-10-21 09:08:07 +00:00
|
|
|
* Multipart streams
|
2017-10-23 16:17:24 +00:00
|
|
|
* Middlewares
|
2017-09-30 16:16:59 +00:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2017-10-14 14:59:35 +00:00
|
|
|
To use `actix-web`, add this to your `Cargo.toml`:
|
2017-09-30 16:16:59 +00:00
|
|
|
|
|
|
|
|
```toml
|
|
|
|
|
[dependencies]
|
2017-10-23 18:48:06 +00:00
|
|
|
actix-web = "0.1"
|
2017-09-30 16:16:59 +00:00
|
|
|
```
|
|
|
|
|
|
2017-10-07 07:53:36 +00:00
|
|
|
## Example
|
|
|
|
|
|
2017-10-23 16:20:12 +00:00
|
|
|
* [Basic](https://github.com/actix/actix-web/tree/master/examples/basic.rs)
|
2017-10-23 18:48:06 +00:00
|
|
|
* [Stateful](https://github.com/actix/actix-web/tree/master/examples/state.rs)
|
2017-10-23 16:20:12 +00: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 16:16:13 +00:00
|
|
|
* [Tcp/Websocket chat](https://github.com/actix/actix-web/tree/master/examples/websocket-chat)
|
2017-10-21 09:08:07 +00:00
|
|
|
|
|
|
|
|
|
2017-10-07 07:53:36 +00:00
|
|
|
```rust
|
|
|
|
|
extern crate actix;
|
2017-10-14 14:59:35 +00:00
|
|
|
extern crate actix_web;
|
2017-10-07 07:53:36 +00:00
|
|
|
extern crate futures;
|
|
|
|
|
|
2017-10-15 22:10:35 +00:00
|
|
|
use actix::*;
|
2017-10-14 14:59:35 +00:00
|
|
|
use actix_web::*;
|
2017-10-07 07:53:36 +00:00
|
|
|
|
|
|
|
|
fn main() {
|
2017-10-08 07:14:52 +00:00
|
|
|
let system = System::new("test");
|
2017-10-07 07:53:36 +00:00
|
|
|
|
|
|
|
|
// start http server
|
2017-10-15 21:17:41 +00:00
|
|
|
HttpServer::new(
|
2017-10-23 16:16:13 +00:00
|
|
|
// create application
|
|
|
|
|
Application::default("/")
|
2017-10-15 21:17:41 +00:00
|
|
|
.resource("/", |r|
|
|
|
|
|
r.handler(Method::GET, |req, payload, state| {
|
|
|
|
|
httpcodes::HTTPOk
|
|
|
|
|
})
|
|
|
|
|
)
|
|
|
|
|
.finish())
|
2017-10-15 21:53:03 +00:00
|
|
|
.serve::<_, ()>("127.0.0.1:8080").unwrap();
|
2017-10-07 07:53:36 +00:00
|
|
|
|
|
|
|
|
// stop system
|
|
|
|
|
Arbiter::handle().spawn_fn(|| {
|
|
|
|
|
Arbiter::system().send(msgs::SystemExit(0));
|
|
|
|
|
futures::future::ok(())
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
system.run();
|
|
|
|
|
}
|
|
|
|
|
```
|
