1
0
mirror of https://github.com/fafhrd91/actix-web synced 2024-12-18 01:43:58 +01:00
actix-web/README.md

65 lines
1.9 KiB
Markdown
Raw Normal View History

2017-10-16 22:16:54 +02:00
# 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)
2017-09-30 18:16:59 +02:00
2017-10-17 05:08:57 +02:00
Web framework for [Actix](https://github.com/fafhrd91/actix).
2017-09-30 18:16:59 +02:00
2017-10-14 16:59:35 +02:00
* [API Documentation](http://fafhrd91.github.io/actix-web/actix_web/)
2017-10-15 08:00:03 +02:00
* Cargo package: [actix-http](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-16 19:43:35 +02:00
Actix web is licensed under the [Apache-2.0 license](http://opensource.org/licenses/APACHE-2.0).
2017-09-30 18:16:59 +02:00
2017-10-07 10:12:43 +02:00
## Features
* HTTP 1.1 and 1.0 support
* Streaming and pipelining support
2017-10-14 01:33:23 +02:00
* Keep-alive and slow requests support
2017-10-14 16:59:35 +02:00
* [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)
2017-09-30 18:16:59 +02:00
## Usage
2017-10-14 16:59:35 +02:00
To use `actix-web`, add this to your `Cargo.toml`:
2017-09-30 18:16:59 +02:00
```toml
[dependencies]
2017-10-14 16:59:35 +02:00
actix-web = { git = "https://github.com/fafhrd91/actix-web.git" }
2017-09-30 18:16:59 +02:00
```
2017-10-07 09:53:36 +02:00
## Example
```rust
extern crate actix;
2017-10-14 16:59:35 +02:00
extern crate actix_web;
2017-10-07 09:53:36 +02:00
extern crate futures;
2017-10-16 00:10:35 +02:00
use actix::*;
2017-10-14 16:59:35 +02:00
use actix_web::*;
2017-10-07 09:53:36 +02:00
fn main() {
2017-10-08 09:14:52 +02:00
let system = System::new("test");
2017-10-07 09:53:36 +02:00
// start http server
2017-10-15 23:17:41 +02:00
HttpServer::new(
2017-10-15 23:19:50 +02:00
// create routing map
2017-10-15 23:17:41 +02:00
RoutingMap::default()
2017-10-15 23:19:50 +02:00
// handler for "GET /"
2017-10-15 23:17:41 +02:00
.resource("/", |r|
r.handler(Method::GET, |req, payload, state| {
httpcodes::HTTPOk
})
)
.finish())
2017-10-15 23:53:03 +02:00
.serve::<_, ()>("127.0.0.1:8080").unwrap();
2017-10-07 09:53:36 +02:00
// stop system
Arbiter::handle().spawn_fn(|| {
Arbiter::system().send(msgs::SystemExit(0));
futures::future::ok(())
});
system.run();
}
```