# axum`axum` is an HTTP routing and request-handling library that focuses on ergonomics and modularity.[![Build status](https://github.com/tokio-rs/axum/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/tokio-rs/axum/actions/workflows/CI.yml)[![Crates.io](https://img.shields.io/crates/v/axum)](https://crates.io/crates/axum)[![Documentation](https://docs.rs/axum/badge.svg)][docs]More information about this crate can be found in the [crate documentation][docs].## High level features- Route requests to handlers with a macro free API.- Declaratively parse requests using extractors.- Simple and predictable error handling model.- Generate responses with minimal boilerplate.- Take full advantage of the [`tower`] and [`tower-http`] ecosystem of  middleware, services, and utilities.In particular the last point is what sets `axum` apart from other libraries / frameworks.`axum` doesn't have its own middleware system but instead uses[`tower::Service`]. This means `axum` gets timeouts, tracing, compression,authorization, and more, for free. It also enables you to share middleware withapplications written using [`hyper`] or [`tonic`].## Usage example```rustuse axum::{    routing::{get, post},    http::StatusCode,    Json, Router,};use serde::{Deserialize, Serialize};#[tokio::main]async fn main() {    // initialize tracing    tracing_subscriber::fmt::init();    // build our application with a route    let app = Router::new()        // `GET /` goes to `root`        .route("/", get(root))        // `POST /users` goes to `create_user`        .route("/users", post(create_user));    // run our app with hyper, listening globally on port 3000    let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();    axum::serve(listener, app).await.unwrap();}// basic handler that responds with a static stringasync fn root() -> &'static str {    "Hello, World!"}async fn create_user(    // this argument tells axum to parse the request body    // as JSON into a `CreateUser` type    Json(payload): Json<CreateUser>,) -> (StatusCode, Json<User>) {    // insert your application logic here    let user = User {        id: 1337,        username: payload.username,    };    // this will be converted into a JSON response    // with a status code of `201 Created`    (StatusCode::CREATED, Json(user))}// the input to our `create_user` handler#[derive(Deserialize)]struct CreateUser {    username: String,}// the output to our `create_user` handler#[derive(Serialize)]struct User {    id: u64,    username: String,}```You can find this [example][readme-example] as well as other example projects inthe [example directory][examples].See the [crate documentation][docs] for way more examples.## Performance`axum` is a relatively thin layer on top of [`hyper`] and adds very littleoverhead. So `axum`'s performance is comparable to [`hyper`]. You can findbenchmarks [here](https://github.com/programatik29/rust-web-benchmarks) and[here](https://web-frameworks-benchmark.netlify.app/result?l=rust).## SafetyThis crate uses `#![forbid(unsafe_code)]` to ensure everything is implemented in100% safe Rust.## Minimum supported Rust versionaxum's MSRV is 1.80.## ExamplesThe [examples] folder contains various examples of how to use `axum`. The[docs] also provide lots of code snippets and examples. For full-fledged examples, check out community-maintained [showcases] or [tutorials].## Getting HelpIn the `axum`'s repo we also have a [number of examples][examples] showing howto put everything together. Community-maintained [showcases] and [tutorials] also demonstrate how to use `axum` for real-world applications. You're also welcome to ask in the [Discord channel][chat] or open a [discussion] with your question.## Community projectsSee [here][ecosystem] for a list of community maintained crates and projectsbuilt with `axum`.## Contributing🎈 Thanks for your help improving the project! We are so happy to haveyou! We have a [contributing guide][contributing] to help you get involved in the`axum` project.## LicenseThis project is licensed under the [MIT license][license].### ContributionUnless you explicitly state otherwise, any contribution intentionally submittedfor inclusion in `axum` by you, shall be licensed as MIT, without anyadditional terms or conditions.[readme-example]: https://github.com/tokio-rs/axum/tree/main/examples/readme[examples]: https://github.com/tokio-rs/axum/tree/main/examples[docs]: https://docs.rs/axum[`tower`]: https://crates.io/crates/tower[`hyper`]: https://crates.io/crates/hyper[`tower-http`]: https://crates.io/crates/tower-http[`tonic`]: https://crates.io/crates/tonic[contributing]: https://github.com/tokio-rs/axum/blob/main/CONTRIBUTING.md[chat]: https://discord.gg/tokio[discussion]: https://github.com/tokio-rs/axum/discussions/new?category=q-a[`tower::Service`]: https://docs.rs/tower/latest/tower/trait.Service.html[ecosystem]: https://github.com/tokio-rs/axum/blob/main/ECOSYSTEM.md[showcases]: https://github.com/tokio-rs/axum/blob/main/ECOSYSTEM.md#project-showcase[tutorials]: https://github.com/tokio-rs/axum/blob/main/ECOSYSTEM.md#tutorials[license]: https://github.com/tokio-rs/axum/blob/main/axum/LICENSE