1
0
mirror of https://github.com/fafhrd91/actix-web synced 2025-01-13 12:15:24 +01:00
actix-web/README.md

80 lines
3.5 KiB
Markdown
Raw Permalink Normal View History

2019-03-28 13:46:26 -07:00
# Actix web [![Build Status](https://travis-ci.org/actix/actix-web.svg?branch=master)](https://travis-ci.org/actix/actix-web) [![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 09:16:59 -07:00
Actix web is a simple, pragmatic and extremely fast web framework for Rust.
2017-12-05 12:25:57 -08:00
2019-03-23 21:29:16 -07:00
* Supported *HTTP/1.x* and *HTTP/2.0* protocols
2017-12-30 16:07:39 +01:00
* Streaming and pipelining
* Keep-alive and slow requests handling
2018-05-23 11:20:12 -07: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 11:20:12 -07:00
* Configurable [request routing](https://actix.rs/docs/url-dispatch/)
2017-12-30 16:07:39 +01:00
* Multipart streams
2018-03-09 05:42:42 -08:00
* Static assets
2019-03-29 16:28:19 -07:00
* SSL support with OpenSSL or Rustls
2019-06-05 09:02:44 +06:00
* Middlewares ([Logger, Session, CORS, etc](https://actix.rs/docs/middleware/))
2018-05-23 11:20:12 -07:00
* Includes an asynchronous [HTTP client](https://actix.rs/actix-web/actix_web/client/index.html)
2019-03-23 21:29:16 -07:00
* Supports [Actix actor framework](https://github.com/actix/actix)
2017-11-04 12:36:37 -07:00
2018-04-10 10:29:10 -07:00
## Documentation & community resources
2017-12-14 20:12:28 -08:00
2018-05-23 11:20:12 -07:00
* [User Guide](https://actix.rs/docs/)
* [API Documentation (1.0)](https://docs.rs/actix-web/)
2018-01-31 06:34:50 -08:00
* [Chat on gitter](https://gitter.im/actix/actix)
* Cargo package: [actix-web](https://crates.io/crates/actix-web)
2019-11-22 07:01:05 +06:00
* Minimum supported Rust version: 1.39 or later
2018-01-31 06:34:50 -08:00
## Example
2018-03-12 09:13:04 -07:00
```rust
2019-11-26 16:07:39 +06:00
use actix_web::{get, App, HttpServer, Responder};
2018-01-31 06:34:50 -08:00
2019-11-26 16:07:39 +06:00
#[get("/{id}/{name}/index.html")]
2019-11-21 21:34:04 +06:00
async fn index(info: web::Path<(u32, String)>) -> impl Responder {
format!("Hello {}! id:{}", info.1, info.0)
2018-01-31 06:34:50 -08:00
}
2019-11-26 17:16:33 +06:00
#[actix_rt::main]
async fn main() -> std::io::Result<()> {
2019-11-26 16:07:39 +06:00
HttpServer::new(|| App::new().service(index))
2019-03-23 21:29:16 -07:00
.bind("127.0.0.1:8080")?
2019-11-26 17:16:33 +06:00
.start()
.await
2018-01-31 06:34:50 -08:00
}
```
2017-12-14 20:12:28 -08:00
2018-01-31 06:34:50 -08:00
### More examples
2017-10-07 00:53:36 -07:00
2018-04-12 20:31:58 -07:00
* [Basics](https://github.com/actix/examples/tree/master/basics/)
* [Stateful](https://github.com/actix/examples/tree/master/state/)
* [Multipart streams](https://github.com/actix/examples/tree/master/multipart/)
2018-04-24 09:16:46 -07:00
* [Simple websocket](https://github.com/actix/examples/tree/master/websocket/)
2018-10-09 13:23:37 -07:00
* [Tera](https://github.com/actix/examples/tree/master/template_tera/) /
2018-04-24 09:16:46 -07:00
[Askama](https://github.com/actix/examples/tree/master/template_askama/) templates
2018-04-12 20:31:58 -07:00
* [Diesel integration](https://github.com/actix/examples/tree/master/diesel/)
2018-04-24 09:34:38 -07:00
* [r2d2](https://github.com/actix/examples/tree/master/r2d2/)
2018-04-12 20:31:58 -07: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 02:08:07 -07:00
2018-02-28 22:31:54 -08:00
You may consider checking out
2018-04-12 20:31:58 -07:00
[this directory](https://github.com/actix/examples/tree/master/) for more examples.
2018-02-28 22:31:54 -08:00
2018-01-31 06:34:50 -08:00
## Benchmarks
2019-07-11 14:45:58 +06:00
* [TechEmpower Framework Benchmark](https://www.techempower.com/benchmarks/#section=data-r18)
2018-02-15 09:53:09 -08:00
2017-12-05 12:25:57 -08:00
## License
2017-10-21 02:08:07 -07:00
2017-12-18 16:48:30 -08: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-18 16:48:30 -08:00
at your option.
2018-01-21 15:29:02 -08: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.