rust-backend-axum
使用 Axum 框架构建生产就绪的 Rust 后端 API。涵盖路由器组合、状态管理、提取器、中间件(身份验证、跟踪)、IntoResponse 错误处理以及正常关闭。在构建 Rust Web 服务、REST API 或使用 Axum、Tower 中间件或异步 Rust 后端时使用。
📖 中文导读:使用 Axum 框架构建生产就绪的 Rust 后端 API。涵盖路由器组合、状态管理、提取器、中间件(身份验证、跟踪)、IntoResponse 错误处理以及正常关闭。在构建 Rust Web 服务、REST API 或使用 Axum、Tower 中间件或异步 Rust 后端时使用。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: rust-backend-axum description: Build production-ready Rust backend APIs with Axum framework. Covers router composition, state management, extractors, middleware (auth, tracing), error handling with IntoResponse, and graceful shutdown. Use when building Rust web services, REST APIs, or when working with Axum, Tower middleware, or async Rust backends.
Build production-ready Rust backend APIs using Axum 0.7+ framework with Tower middleware integration. This skill provides patterns for modular router design, type-safe state management, request extraction, authentication middleware, custom error responses, and graceful shutdown. **1. Extractors Order Matters**Body-consuming extractors (Json, Form, Bytes) must come LAST in handler parameters.
// CORRECT: State and Path before Json
async fn handler(
State(state): State<AppState>,
Path(id): Path<Uuid>,
Json(body): Json<CreateRequest>,
) -> impl IntoResponse { }
2. State Must Be Clone
AppState passed to .with_state() must implement Clone. Use Arc for expensive-to-clone fields.
#[derive(Clone)]
struct AppState {
db: sqlx::PgPool, // PgPool is cheap to clone
config: Arc<Config>, // Arc for expensive data
}
3. route_layer vs layer
- route_layer() - Applies only to routes defined BEFORE it
- layer() - Applies to ALL routes
use axum::{routing::get, Router};
use std::sync::Arc;
#[derive(Clone)]
struct AppState {
db: sqlx::PgPool,
}
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let db = sqlx::PgPool::connect(&std::env::var("DATABASE_URL")?).await?;
let state = AppState { db };
let app = Router::new()
.route("/health", get(|| async { "ok" }))
.with_state(state);
let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await?;
axum::serve(listener, app).await?;
Ok(())
}
**Modular Router Composition**
pub fn create_router(state: AppState) -> Router {
Router::new()
.nest("/api/v1", api_routes())
.route("/health", axum::routing::get(health))
.with_state(state)
}
fn api_routes() -> Router<AppState> {
Router::new()
.nest("/users", users::routes())
.nest("/items", items::routes())
}
**Authentication Middleware with Extension**
use axum::{
extract::{Request, Extension},
middleware::Next,
http::{header, StatusCode},
};
pub async fn auth_middleware(
mut req: Request,
next: Next,
) -> Result<Response, StatusCode> {
let auth_header = req.headers()
.get(header::AUTHORIZATION)
.and_then(|h| h.to_str().ok())
.and_then(|h| h.strip_prefix("Bearer "));
let token = auth_header.ok_or(StatusCode::UNAUTHORIZED)?;
let user = validate_jwt(token).await.map_err(|_| StatusCode::UNAUTHORIZED)?;
req.extensions_mut().insert(user);
Ok(next.run(req).await)
}
// Apply to routes
pub fn protected_routes() -> Router<AppState> {
Router::new()
.route("/profile", get(protected_handler))
.route_layer(middleware::from_fn(auth_middleware))
}
**Tower Middleware Stack**
use tower::ServiceBuilder;
use tower_http::{trace::TraceLayer, timeout::TimeoutLayer, compression::CompressionLayer};
let app = Router::new()
.nest("/api", api_routes())
.with_state(state)
.layer(
ServiceBuilder::new()
.layer(TraceLayer::new_for_http())
.layer(TimeoutLayer::new(Duration::from_secs(30)))
.layer(CompressionLayer::new())
);
- [ ] Router compiles with all routes registered
- [ ] State is Clone and contains Arc for expensive fields
- [ ] Extractors are ordered correctly (body consumers last)
- [ ] Error type implements IntoResponse
- [ ] Auth middleware uses Extension for user propagation
- [ ] Graceful shutdown handles SIGTERM/SIGINT
- [ ] cargo clippy passes without warnings