mirror of https://github.com/fafhrd91/actix-web
docs: update license link to HTTPS
Co-authored-by: KeloYuan <keloyuan@users.noreply.github.com>
This commit is contained in:
Milo
parent
e2db4980cf
commit
b7a29eadee
123
README.md
123
README.md
|
|
@ -1 +1,122 @@
|
|||
actix-web/README.md
|
||||
<div align="center">
|
||||
<h1>Actix Web</h1>
|
||||
<p>
|
||||
<strong>Actix Web is a powerful, pragmatic, and extremely fast web framework for Rust</strong>
|
||||
</p>
|
||||
<p>
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
[](https://crates.io/crates/actix-web)
|
||||
[](https://docs.rs/actix-web/4.13.0)
|
||||
|
||||
|
||||
[](https://deps.rs/crate/actix-web/4.13.0)
|
||||
<br />
|
||||
[](https://github.com/actix/actix-web/actions/workflows/ci.yml)
|
||||
[](https://codecov.io/gh/actix/actix-web)
|
||||
|
||||
[](https://discord.gg/NWpN5mmg3x)
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Features
|
||||
|
||||
- Supports _HTTP/1.x_ and _HTTP/2_
|
||||
- Streaming and pipelining
|
||||
- Powerful [request routing](https://actix.rs/docs/url-dispatch/) with optional macros
|
||||
- Full [Tokio](https://tokio.rs) compatibility
|
||||
- Keep-alive and slow requests handling
|
||||
- Client/server [WebSockets](https://actix.rs/docs/websockets/) support
|
||||
- Transparent content compression/decompression (br, gzip, deflate, zstd)
|
||||
- Multipart streams
|
||||
- Static assets
|
||||
- SSL support using OpenSSL or Rustls
|
||||
- Middlewares ([Logger, Session, CORS, etc](https://actix.rs/docs/middleware/))
|
||||
- Integrates with the [`awc` HTTP client](https://docs.rs/awc/)
|
||||
- Runs on stable Rust 1.88+
|
||||
|
||||
### Experimental features
|
||||
|
||||
To enable faster release iterations, we mark some features as experimental.
|
||||
These features are prefixed with `experimental` and a breaking change may happen at any release.
|
||||
Please use them in a production environment at your own risk.
|
||||
|
||||
- `experimental-introspection`: exposes route and method reporting helpers for local diagnostics
|
||||
and tooling. See [`examples/introspection.rs`](examples/introspection.rs) and
|
||||
[`examples/introspection_multi_servers.rs`](examples/introspection_multi_servers.rs).
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Website & User Guide](https://actix.rs)
|
||||
- [Examples Repository](https://github.com/actix/examples)
|
||||
- [API Documentation](https://docs.rs/actix-web)
|
||||
- [API Documentation (mainranch)](https://actix.rs/actix-web/actix_web)
|
||||
|
||||
## Example
|
||||
|
||||
Dependencies:
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
actix-web = "4"
|
||||
```
|
||||
|
||||
Code:
|
||||
|
||||
```rust
|
||||
use actix_web::{get, web, App, HttpServer, Responder};
|
||||
|
||||
#[get("/hello/{name}")]
|
||||
async fn greet(name: web::Path<String>) -> impl Responder {
|
||||
format!("Hello {name}!")
|
||||
}
|
||||
|
||||
#[actix_web::main] // or #[tokio::main]
|
||||
async fn main() -> std::io::Result<()> {
|
||||
HttpServer::new(|| {
|
||||
App::new().service(greet)
|
||||
})
|
||||
.bind(("127.0.0.1", 8080))?
|
||||
.run()
|
||||
.await
|
||||
}
|
||||
```
|
||||
|
||||
### More Examples
|
||||
|
||||
- [Hello World](https://github.com/actix/examples/tree/main/basics/hello-world)
|
||||
- [Basic Setup](https://github.com/actix/examples/tree/main/basics/basics)
|
||||
- [Application State](https://github.com/actix/examples/tree/main/basics/state)
|
||||
- [JSON Handling](https://github.com/actix/examples/tree/main/json/json)
|
||||
- [Multipart Streams](https://github.com/actix/examples/tree/main/forms/multipart)
|
||||
- [MongoDB Integration](https://github.com/actix/examples/tree/main/databases/mongodb)
|
||||
- [Diesel Integration](https://github.com/actix/examples/tree/main/databases/diesel)
|
||||
- [SQLite Integration](https://github.com/actix/examples/tree/main/databases/sqlite)
|
||||
- [Postgres Integration](https://github.com/actix/examples/tree/main/databases/postgres)
|
||||
- [Tera Templates](https://github.com/actix/examples/tree/main/templating/tera)
|
||||
- [Askama Templates](https://github.com/actix/examples/tree/main/templating/askama)
|
||||
- [HTTPS using Rustls](https://github.com/actix/examples/tree/main/https-tls/rustls)
|
||||
- [HTTPS using OpenSSL](https://github.com/actix/examples/tree/main/https-tls/openssl)
|
||||
- [Simple WebSocket](https://github.com/actix/examples/tree/main/websockets)
|
||||
- [WebSocket Chat](https://github.com/actix/examples/tree/main/websockets/chat)
|
||||
|
||||
You may consider checking out [this directory](https://github.com/actix/examples/tree/main) for more examples.
|
||||
|
||||
## Benchmarks
|
||||
|
||||
One of the fastest web frameworks available according to the [TechEmpower Framework Benchmark](https://www.techempower.com/benchmarks/#section=data-r21&test=composite).
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under either of the following licenses, at your option:
|
||||
|
||||
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0])
|
||||
- MIT license ([LICENSE-MIT](LICENSE-MIT) or [https://opensource.org/licenses/MIT])
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
Contribution to the `actix/actix-web` repo is organized under the terms of the Contributor Covenant. The Actix team promises to intervene to uphold that code of conduct.
|
||||
|
|
|
|||
Loading…
Reference in New Issue