Poem Framework

A program is like a poem, you cannot write a poem without writing it. --- Dijkstra

A full-featured and easy-to-use web framework with the Rust programming language.

• Book
• Docs
• Cargo package

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 to write APIs that comply with OAS3 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 | |------------------|--------------------------------| |compression | Support decompress request body and compress response body | |cookie | Support for Cookie | |multipart | Support for Multipart | |native-tls | Support for HTTP server over TLS with native-tls | |opentelemetry | Support for opentelemetry | |prometheus | Support for Prometheus | |redis-session | Support for RedisSession | |rustls | Support for HTTP server over TLS with rustls | |session | Support for session | |sse | Support Server-Sent Events (SSE) | |staticfiles | Support for serve static files | |tempfile | Support for tempfile | |template | Support for askama | |tower-compat | Adapters for tower::Layer and tower::Service. | |websocket | Support for WebSocket |

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 { format!("hello: {}", name) }

[tokio::main]

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

More examples can be found here.

MSRV

The minimum supported Rust version for this crate is 1.56.1.

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 or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (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.