1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-24 16:02:59 +01:00
actix-extras/README.md

90 lines
4.4 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 18:16:59 +02:00
Actix web is a simple, pragmatic and extremely fast web framework for Rust.
2017-12-05 21:25:57 +01:00
2018-05-23 20:20:12 +02:00
* Supported *HTTP/1.x* and [*HTTP/2.0*](https://actix.rs/docs/http2/) protocols
2017-12-30 16:07:39 +01:00
* Streaming and pipelining
* Keep-alive and slow requests handling
2018-05-23 20:20:12 +02:00
* Client/server [WebSockets](https://actix.rs/docs/websockets/) support
2017-12-30 16:07:39 +01:00
* Transparent content compression/decompression (br, gzip, deflate)
2018-05-23 20:20:12 +02:00
* Configurable [request routing](https://actix.rs/docs/url-dispatch/)
2017-12-30 16:07:39 +01:00
* Graceful server shutdown
* Multipart streams
2018-03-09 14:42:42 +01:00
* Static assets
* SSL support with OpenSSL or `native-tls`
* Middlewares ([Logger](https://actix.rs/book/actix-web/sec-9-middlewares.html#logging),
[Session](https://actix.rs/book/actix-web/sec-9-middlewares.html#user-sessions),
2018-03-01 07:31:54 +01:00
[Redis sessions](https://github.com/actix/actix-redis),
[DefaultHeaders](https://actix.rs/book/actix-web/sec-9-middlewares.html#default-headers),
2018-04-11 04:27:09 +02:00
[CORS](https://actix.rs/actix-web/actix_web/middleware/cors/index.html),
[CSRF](https://actix.rs/actix-web/actix_web/middleware/csrf/index.html))
2018-05-23 20:20:12 +02:00
* Includes an asynchronous [HTTP client](https://actix.rs/actix-web/actix_web/client/index.html)
2018-05-15 19:20:32 +02:00
* Built on top of [Actix actor framework](https://github.com/actix/actix)
2017-11-04 20:36:37 +01:00
2018-04-10 19:29:10 +02:00
## Documentation & community resources
2017-12-15 05:12:28 +01:00
2018-05-23 20:20:12 +02:00
* [User Guide](https://actix.rs/docs/)
2018-04-13 23:36:07 +02:00
* [API Documentation (Development)](https://actix.rs/actix-web/actix_web/)
2018-07-21 13:19:02 +02:00
* [API Documentation (Releases)](https://actix.rs/api/actix-web/stable/actix_web/)
2018-01-31 15:34:50 +01:00
* [Chat on gitter](https://gitter.im/actix/actix)
* Cargo package: [actix-web](https://crates.io/crates/actix-web)
2018-05-25 06:09:20 +02:00
* Minimum supported Rust version: 1.26 or later
2018-01-31 15:34:50 +01:00
## Example
2018-03-12 17:13:04 +01:00
```rust
2018-01-31 15:34:50 +01:00
extern crate actix_web;
2018-05-23 20:20:12 +02:00
use actix_web::{http, server, App, Path, Responder};
2018-01-31 15:34:50 +01:00
2018-05-23 20:20:12 +02:00
fn index(info: Path<(u32, String)>) -> impl Responder {
format!("Hello {}! id:{}", info.1, info.0)
2018-01-31 15:34:50 +01:00
}
fn main() {
2018-04-06 18:45:10 +02:00
server::new(
2018-04-01 02:15:44 +02:00
|| App::new()
2018-04-10 19:39:16 +02:00
.route("/{id}/{name}/index.html", http::Method::GET, index))
2018-01-31 15:34:50 +01:00
.bind("127.0.0.1:8080").unwrap()
.run();
}
```
2017-12-15 05:12:28 +01:00
2018-01-31 15:34:50 +01:00
### More examples
2017-10-07 09:53:36 +02:00
2018-04-13 05:31:58 +02:00
* [Basics](https://github.com/actix/examples/tree/master/basics/)
* [Stateful](https://github.com/actix/examples/tree/master/state/)
* [Protobuf support](https://github.com/actix/examples/tree/master/protobuf/)
* [Multipart streams](https://github.com/actix/examples/tree/master/multipart/)
2018-04-24 18:16:46 +02:00
* [Simple websocket](https://github.com/actix/examples/tree/master/websocket/)
* [Tera](https://github.com/actix/examples/tree/master/template_tera/) /
[Askama](https://github.com/actix/examples/tree/master/template_askama/) templates
2018-04-13 05:31:58 +02:00
* [Diesel integration](https://github.com/actix/examples/tree/master/diesel/)
2018-04-24 18:34:38 +02:00
* [r2d2](https://github.com/actix/examples/tree/master/r2d2/)
2018-04-13 05:31:58 +02:00
* [SSL / HTTP/2.0](https://github.com/actix/examples/tree/master/tls/)
* [Tcp/Websocket chat](https://github.com/actix/examples/tree/master/websocket-chat/)
* [Json](https://github.com/actix/examples/tree/master/json/)
2017-10-21 11:08:07 +02:00
2018-03-01 07:31:54 +01:00
You may consider checking out
2018-04-13 05:31:58 +02:00
[this directory](https://github.com/actix/examples/tree/master/) for more examples.
2018-03-01 07:31:54 +01:00
2018-01-31 15:34:50 +01:00
## Benchmarks
* [TechEmpower Framework Benchmark](https://www.techempower.com/benchmarks/#section=data-r16&hw=ph&test=plaintext)
2018-02-15 18:53:09 +01:00
2018-02-28 00:13:59 +01:00
* Some basic benchmarks could be found in this [repository](https://github.com/fafhrd91/benchmarks).
2018-01-31 15:34:50 +01: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.
2018-01-22 00:29:02 +01: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.