<h1 align="center">Poem Framework</h1>

<div align="center">
  <!-- Crates version -->
  <a href="https://crates.io/crates/poem">
    <img src="https://img.shields.io/crates/v/poem.svg?style=flat-square"
    alt="Crates.io version" />
  </a>
  <!-- Downloads -->
  <a href="https://crates.io/crates/poem">
    <img src="https://img.shields.io/crates/d/poem.svg?style=flat-square"
      alt="Download" />
  </a>
  <!-- docs.rs docs -->
  <a href="https://docs.rs/poem">
    <img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square"
      alt="docs.rs docs" />
  </a>
  <a href="https://github.com/rust-secure-code/safety-dance/">
    <img src="https://img.shields.io/badge/unsafe-forbidden-success.svg?style=flat-square"
      alt="Unsafe Rust forbidden" />
  </a>
  <a href="https://blog.rust-lang.org/2023/11/16/Rust-1.81.0.html">
    <img src="https://img.shields.io/badge/rustc-1.81.0+-ab6000.svg"
      alt="rustc 1.81.0+" />
  </a>
  <a href="https://discord.gg/qWWNxwasb7">
    <img src="https://img.shields.io/discord/932986985604333638.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2" />
  </a>
</div>
<p align="center"><code>A program is like a poem, you cannot write a poem without writing it. --- Dijkstra</code></p>
<p align="center"> A full-featured and easy-to-use web framework with the Rust programming language.</p>

***

* [Docs](https://docs.rs/poem)
* [Cargo package](https://crates.io/crates/poem)

## Features

- Both _Ease_ of use and performance.
- Minimizing the use of generics.
- Blazing fast and flexible routing.
- `tower::Service` and `tower::Layer` compatibility.
- Use [poem-openapi](https://crates.io/crates/poem-openapi) to write APIs that comply with [OAS3](https://github.com/OAI/OpenAPI-Specification) specifications and automatically generate documents.

## Crate features

To avoid compiling unused dependencies, Poem gates certain features, all of
which are disabled by default:

| Feature       | Description                                                                               |
|---------------|-------------------------------------------------------------------------------------------|
| server        | Server and listener APIs (enabled by default)                                               |                                                     |
| compression   | Support decompress request body and compress response body                                |
| cookie        | Support for Cookie                                                                        |
| csrf          | Support for Cross-Site Request Forgery (CSRF) protection                                  |
| multipart     | Support for Multipart                                                                     |
| native-tls    | Support for HTTP server over TLS with [`native-tls`](https://crates.io/crates/native-tls) |
| openssl-tls   | Support for HTTP server over TLS with [`openssl-tls`](https://crates.io/crates/openssl)   |
| opentelemetry | Support for opentelemetry                                                                 |
| prometheus    | Support for Prometheus                                                                    |
| redis-session | Support for RedisSession                                                                  |
| rustls        | Support for HTTP server over TLS with [`rustls`](https://crates.io/crates/rustls)         |
| session       | Support for session                                                                       |
| sse           | Support Server-Sent Events (SSE)                                                          |
| static-files  | Support static files endpoint                                                             | 
| tempfile      | Support for [`tempfile`](https://crates.io/crates/tempfile)                               |
| tower-compat  | Adapters for `tower::Layer` and `tower::Service`.                                         |
| websocket     | Support for WebSocket                                                                     |
| anyhow        | Integrate with [`anyhow`](https://crates.io/crates/anyhow) crate.                         |
| eyre06        | Integrate with version 0.6.x of the [`eyre`](https://crates.io/crates/eyre) crate.        |
| i18n          | Support for internationalization                                                          |
| acme-native-roots | Support for ACME(Automatic Certificate Management Environment)                            |
| acme-webpki-roots | Support for ACME using webpki TLS roots rather than native TLS roots                  |
| tokio-metrics | Integrate with [`tokio-metrics`](https://crates.io/crates/tokio-metrics) crate.           |
| embed         | Integrate with [`rust-embed`](https://crates.io/crates/rust-embed) crate.                 |
| xml           | Integrate with [`quick-xml`](https://crates.io/crates/quick-xml) crate.                   |
| yaml           | Integrate with [`serde-yaml`](https://crates.io/crates/serde-yaml) crate.                   |
|requestid      |Associates an unique ID with each incoming request                                 |
|sonic-rs       | Uses [`sonic-rs`](https://github.com/cloudwego/sonic-rs) instead of `serde_json`. Pls, checkout `sonic-rs` requirements to properly enable `sonic-rs` capabilities          |
## Safety

This crate uses `#![forbid(unsafe_code)]` to ensure everything is implemented in 100% Safe Rust.

## Example

```rust, no_run
use poem::{get, handler, listener::TcpListener, web::Path, Route, Server};

#[handler]
fn hello(Path(name): Path<String>) -> String {
    format!("hello: {}", name)
}

#[tokio::main]
async fn main() -> Result<(), std::io::Error> {
    let app = Route::new().at("/hello/:name", get(hello));
    Server::new(TcpListener::bind("0.0.0.0:3000"))
      .run(app)
      .await
}
```

More examples can be found [here][examples].

[examples]: https://github.com/poem-web/poem/tree/master/examples

## MSRV

The minimum supported Rust version for this crate is `1.81.0`.

## Contributing

:balloon: Thanks for your help improving the project! We are so happy to have you!


## License

Licensed under either of

* 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 http://opensource.org/licenses/MIT)
  at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Poem by you, shall be licensed as Apache, without any additional terms or conditions.
