Auxm Github README

axum是一个注重人体工程学和模块化的Web应用程序框架。

有关此Crate的更多信息，请参阅 此Crate的文档。

高级功能

• 使用无宏 API 将请求路由到处理程序。
• 使用提取器以声明方式解析请求。
• 简单且可预测的错误处理模型。
• 使用最少的样板生成响应。
• 充分利用中间件、服务和实用程序的生态系统tower。tower-http

尤其是最后一点，正是它axum与其他框架的不同之处。 axum它没有自己的中间件系统，而是使用 tower::Service。这意味着可以免费获得超时、跟踪、压缩、授权等功能。它还允许您与使用或axum编写的应用程序共享中间件。hypertonic

⚠ 重大变更 ⚠

我们目前正在开发 axum 0.9 版本，因此该 main 分支包含重大变更。查看该 0.8.x 分支，了解已发布到 crates.io 的内容。

使用示例

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,
}

您可以在示例目录中找到此示例以及其他示例项目。

请参阅板条箱文档以获取更多示例。

性能

axum 是 hyper 之上相对较薄的一层，几乎不增加任何开销。因此axum的性能与 hyper 相当。您可以在这里和 这里找到基准测试。

安全

该板条箱用于 #![forbid(unsafe_code)] 确保一切都以 100% 安全的 Rust 实现。

支持的最低 Rust 版本

Auxm 的 MSRV 为 1.75。

示例

示例文件夹包含各种使用示例axum。 文档也提供了大量代码片段和示例。如需完整的示例，请查看社区维护的案例或教程。

获取帮助

在 axum 的仓库中，我们还有很多 示例 展示了如何将所有内容整合在一起。社区维护的样例和教程也演示了如何 axum 在实际应用中使用。也欢迎您在Discord 频道提问或开启讨论。

社区项目

请参阅此处，查看由 构建的社区维护的板条箱和项目的列表axum。

贡献

🎈 感谢您对项目的改进！我们非常高兴您能加入我们！我们准备了一份贡献指南，帮助您参与到 axum项目中。

许可

该项目已获得MIT 许可。

贡献

axum 除非您明确声明，否则您有意提交的任何贡献均应获得 MIT 许可，无需任何附加条款或条件。