1
0
mirror of https://github.com/fafhrd91/actix-web synced 2024-11-24 00:21:08 +01:00
actix-web/README.md

71 lines
3.4 KiB
Markdown
Raw Normal View History

2017-12-26 20:04:25 +01: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) [![Join the chat at https://gitter.im/actix/actix](https://badges.gitter.im/actix/actix.svg)](https://gitter.im/actix/actix?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
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::*;
2017-12-08 21:51:44 +01:00
fn index(req: HttpRequest) -> String {
format!("Hello {}!", &req.match_info()["name"])
2017-12-05 21:25:57 +01:00
}
fn main() {
2017-12-08 21:51:44 +01:00
HttpServer::new(
2017-12-14 06:44:16 +01:00
|| Application::new()
2017-12-12 04:17:37 +01:00
.resource("/{name}", |r| r.f(index)))
2017-12-17 21:35:04 +01:00
.bind("127.0.0.1:8080")?
.start();
2017-12-05 21:25:57 +01:00
}
```
## 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-12-30 16:07:39 +01:00
* Supported *HTTP/1.x* and *HTTP/2.0* protocols
* Streaming and pipelining
* Keep-alive and slow requests handling
* [WebSockets](https://actix.github.io/actix-web/actix_web/ws/index.html)
* Transparent content compression/decompression (br, gzip, deflate)
* Configurable request routing
* Graceful server shutdown
* Multipart streams
* Middlewares ([Logger](https://actix.github.io/actix-web/guide/qs_10.html#logging),
[Session](https://actix.github.io/actix-web/guide/qs_10.html#user-sessions),
[DefaultHeaders](https://actix.github.io/actix-web/guide/qs_10.html#default-headers))
* Built on top of [Actix](https://github.com/actix/actix).
2017-11-04 20:36:37 +01:00
2017-12-15 05:12:28 +01:00
## Benchmarks
2017-12-16 20:39:56 +01:00
Some basic benchmarks could be found in this [respository](https://github.com/fafhrd91/benchmarks).
2017-12-15 05:12:28 +01:00
2017-12-05 21:25:57 +01:00
## Examples
2017-10-07 09:53:36 +02:00
* [Basic](https://github.com/actix/actix-web/tree/master/examples/basic/)
2017-10-23 20:48:06 +02:00
* [Stateful](https://github.com/actix/actix-web/tree/master/examples/state.rs)
2017-12-19 01:42:58 +01:00
* [Mulitpart streams](https://github.com/actix/actix-web/tree/master/examples/multipart/)
2017-10-23 18:20:12 +02:00
* [Simple websocket session](https://github.com/actix/actix-web/tree/master/examples/websocket.rs)
2017-12-19 01:42:58 +01:00
* [Tera templates](https://github.com/actix/actix-web/tree/master/examples/template_tera/)
* [Diesel integration](https://github.com/actix/actix-web/tree/master/examples/diesel/)
* [SSL / HTTP/2.0](https://github.com/actix/actix-web/tree/master/examples/tls/)
* [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-12-30 16:07:39 +01:00
* [Json](https://github.com/actix/actix-web/tree/master/examples/json/)
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-19 01:48:30 +01:00
This project is licensed under either of
2017-12-30 16:07:39 +01: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 01:48:30 +01:00
at your option.
2017-12-20 01:14:47 +01:00
2017-12-28 02:49:10 +01:00
[![Analytics](https://ga-beacon.appspot.com/UA-110322332-2/actix-web/readme?flat&useReferer)](https://github.com/igrigorik/ga-beacon)