1
0
Fork 0
mirror of https://github.com/actix/actix-web.git synced 2024-12-22 16:16:40 +00:00
actix-web/README.md

114 lines
4.3 KiB
Markdown
Raw Normal View History

2019-12-06 06:22:29 +00:00
<div align="center">
<p><h1>Actix web</h1> </p>
2019-12-06 06:29:10 +00:00
<p><strong>Actix web is a small, pragmatic, and extremely fast rust web framework</strong> </p>
2019-12-06 06:22:29 +00:00
<p>
[![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)
2019-12-08 13:27:06 +00:00
[![crates.io](https://meritbadge.herokuapp.com/actix-web)](https://crates.io/crates/actix-web)
2019-12-06 06:22:29 +00:00
[![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)
[![Documentation](https://docs.rs/actix-web/badge.svg)](https://docs.rs/actix-web)
2019-12-06 06:59:11 +00:00
[![Download](https://img.shields.io/crates/d/actix-web.svg)](https://crates.io/crates/actix-web)
2020-05-13 00:57:37 +00:00
[![Version](https://img.shields.io/badge/rustc-1.40+-lightgray.svg)](https://blog.rust-lang.org/2019/12/19/Rust-1.40.0.html)
2019-12-06 06:22:29 +00:00
![License](https://img.shields.io/crates/l/actix-web.svg)
2019-12-08 13:27:06 +00:00
2019-12-06 06:22:29 +00:00
</p>
2019-12-08 13:27:06 +00:00
2019-12-06 06:22:29 +00:00
<h3>
<a href="https://actix.rs">Website</a>
<span> | </span>
2019-12-08 13:27:06 +00:00
<a href="https://gitter.im/actix/actix">Chat</a>
2019-12-06 06:22:29 +00:00
<span> | </span>
<a href="https://github.com/actix/examples">Examples</a>
</h3>
</div>
2019-12-06 06:23:28 +00:00
<br>
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
2019-03-24 04:29:16 +00:00
* Supported *HTTP/1.x* and *HTTP/2.0* protocols
2017-12-30 15:07:39 +00:00
* Streaming and pipelining
* Keep-alive and slow requests handling
2018-05-23 18:20:12 +00:00
* Client/server [WebSockets](https://actix.rs/docs/websockets/) support
2017-12-30 15:07:39 +00:00
* Transparent content compression/decompression (br, gzip, deflate)
2018-05-23 18:20:12 +00:00
* Configurable [request routing](https://actix.rs/docs/url-dispatch/)
2017-12-30 15:07:39 +00:00
* Multipart streams
2018-03-09 13:42:42 +00:00
* Static assets
2019-03-29 23:28:19 +00:00
* SSL support with OpenSSL or Rustls
2019-06-05 03:02:44 +00:00
* Middlewares ([Logger, Session, CORS, etc](https://actix.rs/docs/middleware/))
2018-05-23 18:20:12 +00:00
* Includes an asynchronous [HTTP client](https://actix.rs/actix-web/actix_web/client/index.html)
2019-03-24 04:29:16 +00:00
* Supports [Actix actor framework](https://github.com/actix/actix)
2020-05-13 00:57:37 +00:00
* Supports Rust 1.40+
2017-11-04 19:36:37 +00:00
2020-04-07 19:48:01 +00:00
## Docs
* [API documentation (master)](https://actix.rs/actix-web/actix_web)
* [API documentation (docs.rs)](https://docs.rs/actix-web)
* [User guide](https://actix.rs)
2018-01-31 14:34:50 +00:00
## Example
2020-01-16 14:17:17 +00:00
Dependencies:
```toml
[dependencies]
actix-web = "2"
actix-rt = "1"
```
Code:
2018-03-12 16:13:04 +00:00
```rust
use actix_web::{get, web, App, HttpServer, Responder};
2018-01-31 14:34:50 +00:00
2019-11-26 10:07:39 +00:00
#[get("/{id}/{name}/index.html")]
2019-11-21 15:34:04 +00:00
async fn index(info: web::Path<(u32, String)>) -> impl Responder {
format!("Hello {}! id:{}", info.1, info.0)
2018-01-31 14:34:50 +00:00
}
2019-11-26 11:16:33 +00:00
#[actix_rt::main]
async fn main() -> std::io::Result<()> {
2019-11-26 10:07:39 +00:00
HttpServer::new(|| App::new().service(index))
2019-03-24 04:29:16 +00:00
.bind("127.0.0.1:8080")?
2019-12-22 13:16:07 +00:00
.run()
2019-11-26 11:16:33 +00:00
.await
2018-01-31 14:34:50 +00:00
}
```
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-04-13 03:31:58 +00: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 16:16:46 +00:00
* [Simple websocket](https://github.com/actix/examples/tree/master/websocket/)
2020-04-07 19:48:01 +00:00
* [Tera](https://github.com/actix/examples/tree/master/template_tera/)
2020-01-16 14:17:17 +00:00
* [Askama](https://github.com/actix/examples/tree/master/template_askama/) templates
2018-04-13 03:31:58 +00:00
* [Diesel integration](https://github.com/actix/examples/tree/master/diesel/)
2018-04-24 16:34:38 +00:00
* [r2d2](https://github.com/actix/examples/tree/master/r2d2/)
* [OpenSSL](https://github.com/actix/examples/tree/master/openssl/)
* [Rustls](https://github.com/actix/examples/tree/master/rustls/)
2018-04-13 03:31:58 +00:00
* [Tcp/Websocket chat](https://github.com/actix/examples/tree/master/websocket-chat/)
* [Json](https://github.com/actix/examples/tree/master/json/)
2017-10-21 09:08:07 +00:00
2018-03-01 06:31:54 +00:00
You may consider checking out
2018-04-13 03:31:58 +00:00
[this directory](https://github.com/actix/examples/tree/master/) for more examples.
2018-03-01 06:31:54 +00:00
2018-01-31 14:34:50 +00:00
## Benchmarks
2019-07-11 08:45:58 +00:00
* [TechEmpower Framework Benchmark](https://www.techempower.com/benchmarks/#section=data-r18)
2018-02-15 17:53:09 +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.