1
0
Fork 0
mirror of https://github.com/actix/actix-web.git synced 2024-12-24 00:50:36 +00:00
actix-web/README.md
2017-10-21 02:08:07 -07:00

70 lines
2.2 KiB
Markdown

# Actix web [![Build Status](https://travis-ci.org/fafhrd91/actix-web.svg?branch=master)](https://travis-ci.org/fafhrd91/actix-web) [![Build Status](https://ci.appveyor.com/api/projects/status/github/fafhrd91/actix-web?branch=master&svg=true)](https://ci.appveyor.com/project/fafhrd91/actix-web) [![codecov](https://codecov.io/gh/fafhrd91/actix-web/branch/master/graph/badge.svg)](https://codecov.io/gh/fafhrd91/actix-web)
Web framework for [Actix](https://github.com/fafhrd91/actix).
* [API Documentation](http://fafhrd91.github.io/actix-web/actix_web/)
* Cargo package: [actix-http](https://crates.io/crates/actix-web)
* Minimum supported Rust version: 1.20 or later
---
Actix web is licensed under the [Apache-2.0 license](http://opensource.org/licenses/APACHE-2.0).
## Features
* HTTP 1.1 and 1.0 support
* Streaming and pipelining support
* Keep-alive and slow requests support
* [WebSockets support](https://fafhrd91.github.io/actix-web/actix_web/ws/index.html)
* [Configurable request routing](https://fafhrd91.github.io/actix-web/actix_web/struct.RoutingMap.html)
* Multipart streams
## Usage
To use `actix-web`, add this to your `Cargo.toml`:
```toml
[dependencies]
actix-web = { git = "https://github.com/fafhrd91/actix-web.git" }
```
## Example
* [Mulitpart support](https://github.com/fafhrd91/actix-web/tree/master/examples/multipart)
* [Simple websocket example](https://github.com/fafhrd91/actix-web/tree/master/examples/websocket)
* [Tcp/Websocket chat](https://github.com/fafhrd91/actix-web/tree/master/examples/websocket-chat)
```rust
extern crate actix;
extern crate actix_web;
extern crate futures;
use actix::*;
use actix_web::*;
fn main() {
let system = System::new("test");
// start http server
HttpServer::new(
// create routing map
RoutingMap::default()
// handler for "GET /"
.resource("/", |r|
r.handler(Method::GET, |req, payload, state| {
httpcodes::HTTPOk
})
)
.finish())
.serve::<_, ()>("127.0.0.1:8080").unwrap();
// stop system
Arbiter::handle().spawn_fn(|| {
Arbiter::system().send(msgs::SystemExit(0));
futures::future::ok(())
});
system.run();
}
```