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

87 lines
4.3 KiB
Markdown
Raw Normal View History

# 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](https://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 16:16:59 +00:00
Actix web is a simple, pragmatic and extremely fast web framework for Rust.
2017-12-05 20:25:57 +00:00
2018-04-11 02:27:09 +00:00
* Supported *HTTP/1.x* and [*HTTP/2.0*](https://actix.rs/actix-web/guide/qs_13.html) protocols
2017-12-30 15:07:39 +00:00
* Streaming and pipelining
* Keep-alive and slow requests handling
2018-04-11 02:27:09 +00:00
* Client/server [WebSockets](https://actix.rs/actix-web/guide/qs_9.html) support
2017-12-30 15:07:39 +00:00
* Transparent content compression/decompression (br, gzip, deflate)
2018-04-11 02:27:09 +00:00
* Configurable [request routing](https://actix.rs/actix-web/guide/qs_5.html)
2017-12-30 15:07:39 +00:00
* Graceful server shutdown
* Multipart streams
2018-03-09 13:42:42 +00:00
* Static assets
* SSL support with OpenSSL or `native-tls`
2018-04-11 02:27:09 +00:00
* Middlewares ([Logger](https://actix.rs/actix-web/guide/qs_10.html#logging),
[Session](https://actix.rs/actix-web/guide/qs_10.html#user-sessions),
2018-03-01 06:31:54 +00:00
[Redis sessions](https://github.com/actix/actix-redis),
2018-04-11 02:27:09 +00:00
[DefaultHeaders](https://actix.rs/actix-web/guide/qs_10.html#default-headers),
[CORS](https://actix.rs/actix-web/actix_web/middleware/cors/index.html),
[CSRF](https://actix.rs/actix-web/actix_web/middleware/csrf/index.html))
* Built on top of [Actix actor framework](https://github.com/actix/actix)
2017-11-04 19:36:37 +00:00
2018-04-10 17:29:10 +00:00
## Documentation & community resources
2017-12-15 04:12:28 +00:00
2018-04-11 17:49:34 +00:00
* [User Guide](https://actix.github.io/actix-web/guide/)
* [API Documentation (Development)](https://actix.github.io/actix-web/actix_web/)
2018-01-31 14:34:50 +00:00
* [API Documentation (Releases)](https://docs.rs/actix-web/)
* [Chat on gitter](https://gitter.im/actix/actix)
* Cargo package: [actix-web](https://crates.io/crates/actix-web)
* Minimum supported Rust version: 1.21 or later
## Example
2018-03-12 16:13:04 +00:00
```rust
2018-01-31 14:34:50 +00:00
extern crate actix_web;
2018-04-10 17:39:16 +00:00
use actix_web::{http, server, App, Path};
2018-01-31 14:34:50 +00:00
2018-04-10 17:29:10 +00:00
fn index(info: Path<(u32, String)>) -> String {
2018-03-29 22:07:12 +00:00
format!("Hello {}! id:{}", info.0, info.1)
2018-01-31 14:34:50 +00:00
}
fn main() {
2018-04-06 16:45:10 +00:00
server::new(
2018-04-01 00:15:44 +00:00
|| App::new()
2018-04-10 17:39:16 +00:00
.route("/{id}/{name}/index.html", http::Method::GET, index))
2018-01-31 14:34:50 +00:00
.bind("127.0.0.1:8080").unwrap()
.run();
}
```
2017-12-15 04:12:28 +00:00
2018-01-31 14:34:50 +00:00
### More examples
2017-10-07 07:53:36 +00:00
2018-01-08 18:10:47 +00:00
* [Basics](https://github.com/actix/actix-web/tree/master/examples/basics/)
* [Stateful](https://github.com/actix/actix-web/tree/master/examples/state/)
2018-03-09 04:58:05 +00:00
* [Protobuf support](https://github.com/actix/actix-web/tree/master/examples/protobuf/)
2018-02-27 23:13:59 +00:00
* [Multipart streams](https://github.com/actix/actix-web/tree/master/examples/multipart/)
* [Simple websocket session](https://github.com/actix/actix-web/tree/master/examples/websocket/)
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-12-30 15:07:39 +00:00
* [Json](https://github.com/actix/actix-web/tree/master/examples/json/)
2017-10-21 09:08:07 +00:00
2018-03-01 06:31:54 +00:00
You may consider checking out
[this directory](https://github.com/actix/actix-web/tree/master/examples) for more examples.
2018-01-31 14:34:50 +00:00
## Benchmarks
2018-02-15 17:53:09 +00:00
* [TechEmpower Framework Benchmark](https://www.techempower.com/benchmarks/#section=data-r15&hw=ph&test=plaintext)
2018-02-27 23:13:59 +00:00
* Some basic benchmarks could be found in this [repository](https://github.com/fafhrd91/benchmarks).
2018-01-31 14:34:50 +00:00
2017-12-05 20:25:57 +00:00
## License
2017-10-21 09:08:07 +00:00
2017-12-19 00:48:30 +00:00
This project is licensed under either of
2017-12-30 15:07:39 +00: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 00:48:30 +00:00
at your option.
2018-01-21 23:29:02 +00:00
## Code of Conduct
Contribution to the actix-web crate is organized under the terms of the
Contributor Covenant, the maintainer of actix-web, @fafhrd91, promises to
intervene to uphold that code of conduct.