1
0
Fork 0
mirror of https://github.com/actix/actix-web.git synced 2024-06-12 10:19:36 +00:00
actix-web/README.md

62 lines
2.8 KiB
Markdown
Raw Normal View History

2017-10-23 22:58:05 +00: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 16:16:59 +00:00
2017-12-05 20:25:57 +00:00
Actix web is a small, fast, down-to-earth, open source rust web framework.
```rust,ignore
use actix_web::*;
2017-12-08 20:51:44 +00:00
fn index(req: HttpRequest) -> String {
format!("Hello {}!", &req.match_info()["name"])
2017-12-05 20:25:57 +00:00
}
fn main() {
2017-12-08 20:51:44 +00:00
HttpServer::new(
2017-12-14 05:44:16 +00:00
|| Application::new()
2017-12-12 03:17:37 +00:00
.resource("/{name}", |r| r.f(index)))
2017-12-17 20:35:04 +00:00
.bind("127.0.0.1:8080")?
.start();
2017-12-05 20:25:57 +00:00
}
```
## Documentation
2017-09-30 16:16:59 +00:00
2017-11-28 03:56:14 +00:00
* [User Guide](http://actix.github.io/actix-web/guide/)
2017-10-23 22:58:05 +00:00
* [API Documentation (Development)](http://actix.github.io/actix-web/actix_web/)
* [API Documentation (Releases)](https://docs.rs/actix-web/)
2017-10-30 23:37:26 +00:00
* Cargo package: [actix-web](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-07 08:12:43 +00:00
## Features
2017-12-14 07:35:21 +00: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)
2017-11-09 03:42:13 +00:00
* Transparent content compression/decompression (br, gzip, deflate)
2017-10-23 16:17:24 +00:00
* Configurable request routing
2017-10-21 09:08:07 +00:00
* Multipart streams
2017-12-17 20:35:04 +00:00
* Middlewares ([Logger](https://actix.github.io/actix-web/guide/qs_10.html#logging),
2017-12-17 18:03:37 +00:00
[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))
2017-12-05 20:25:57 +00:00
* Built on top of [Actix](https://github.com/actix/actix).
2017-11-04 19:36:37 +00:00
2017-12-15 04:12:28 +00:00
## Benchmarks
2017-12-16 19:39:56 +00:00
Some basic benchmarks could be found in this [respository](https://github.com/fafhrd91/benchmarks).
2017-12-15 04:12:28 +00:00
2017-12-05 20:25:57 +00:00
## Examples
2017-10-07 07:53:36 +00:00
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-12-19 00:42:58 +00:00
* [Mulitpart streams](https://github.com/actix/actix-web/tree/master/examples/multipart/)
2017-10-23 16:20:12 +00:00
* [Simple websocket session](https://github.com/actix/actix-web/tree/master/examples/websocket.rs)
2017-12-19 00:42:58 +00: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 16:07:44 +00:00
* [SockJS Server](https://github.com/actix/actix-sockjs)
2017-10-21 09:08:07 +00:00
2017-12-05 20:25:57 +00:00
## License
2017-10-21 09:08:07 +00:00
2017-12-05 20:25:57 +00:00
Actix web is licensed under the [Apache-2.0 license](http://opensource.org/licenses/APACHE-2.0).