Ergonomic and modular web framework built with Tokio, Tower, and Hyper https://crates.io/crates/axum
Go to file
David Mládek 0a92e31a50
axum-extra: Log rejections of `TypedHeader` (#2738)
Co-authored-by: Jonas Platte <jplatte+git@posteo.de>
2024-05-27 21:55:30 +00:00
.github ci: Bump `crate-ci/typos` to v1.20.8 (#2711) 2024-04-16 02:56:01 -04:00
axum Fix typo in docs (#2727) 2024-05-02 18:34:09 -04:00
axum-core Enable diagnostic attributes for Rust 1.78+ (#2693) 2024-04-30 11:05:38 -04:00
axum-extra axum-extra: Log rejections of `TypedHeader` (#2738) 2024-05-27 21:55:30 +00:00
axum-macros Add #[debug_middleware] (#2725) 2024-05-02 17:27:12 -04:00
examples Fix typo in serve-with-hyper example (#2750) 2024-05-27 12:17:07 -04:00
.gitignore Re-integrate examples into the root workspace (#1466) 2023-03-10 12:02:11 +01:00
.typos.toml Check for typos in CI 2023-08-08 11:27:45 +02:00
CHANGELOG.md Move axum crate into workspace subfolder (#458) 2021-11-03 12:38:48 +01:00
CONTRIBUTING.md Fix typo in CONTRIBUTING.md (#2612) 2024-02-25 21:47:01 +01:00
Cargo.toml Upgrade headers to 0.4.0 (#2351) 2023-11-25 08:47:57 +00:00
ECOSYSTEM.md Add axum-typed-routing to ECOSYSTEM.md (#2608) 2024-03-14 22:12:15 +00:00
README.md Move axum crate into workspace subfolder (#458) 2021-11-03 12:38:48 +01:00
_typos.toml Update to latest versions of hyper and http-body (#1882) 2023-11-23 11:03:03 +00:00
deny.toml fix cargo-deny 2023-09-16 21:32:40 +02:00

README.md

axum

axum is a web application framework that focuses on ergonomics and modularity.

Build status Crates.io Documentation

More information about this crate can be found in the crate documentation.

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 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 with applications written using hyper or tonic.

Usage example

use 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 string
async 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 as well as other example projects in the example directory.

See the crate documentation for way more examples.

Performance

axum is a relatively thin layer on top of hyper and adds very little overhead. So axum's performance is comparable to hyper. You can find benchmarks here and here.

Safety

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

Minimum supported Rust version

axum's MSRV is 1.66.

Examples

The 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 Help

In the axum's repo we also have a number of examples showing how to 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 or open a discussion with your question.

Community projects

See here for a list of community maintained crates and projects built with axum.

Contributing

🎈 Thanks for your help improving the project! We are so happy to have you! We have a contributing guide to help you get involved in the axum project.

License

This project is licensed under the MIT license.

Contribution

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