- Overall:
-
fixed: All known compile time issues are resolved, including those with
boxed
and those introduced by Rust 1.56 (#404) -
breaking: The router's type is now always
Router
regardless of how many routes or
middleware are applied (#404)This means router types are all always nameable:
fn my_routes() -> Router { Router::new().route( "/users", post(|| async { "Hello, World!" }), ) }
-
breaking: Added feature flags for HTTP1 and JSON. This enables removing a
few dependencies if your app only uses HTTP2 or doesn't use JSON. Its only a
breaking change if you depend on axum withdefault_features = false
. (#286) -
breaking:
Route::boxed
andBoxRoute
have been removed as they're no longer
necessary (#404) -
breaking:
Nested
,Or
types are now private. They no longer had to be
public becauseRouter
is internally boxed (#404) -
breaking: Remove
routing::Layered
as it didn't actually do anything and
thus wasn't necessary -
breaking: Vendor
AddExtensionLayer
andAddExtension
to reduce public
dependencies -
breaking:
body::BoxBody
is now a type alias for
http_body::combinators::UnsyncBoxBody
and thus is no longerSync
. This
is because bodies are streams and requiring streams to beSync
is
unnecessary. -
added: Implement
IntoResponse
forhttp_body::combinators::UnsyncBoxBody
. -
added: Add
Handler::into_make_service
for serving a handler without a
Router
. -
added: Add
Handler::into_make_service_with_connect_info
for serving a
handler without aRouter
, and storing info about the incoming connection. -
breaking: axum's minimum support rust version is now 1.54
-
- Routing:
- Big internal refactoring of routing leading to several improvements (#363)
- added: Wildcard routes like
.route("/api/users/*rest", service)
are now supported. - fixed: The order routes are added in no longer matters.
- fixed: Adding a conflicting route will now cause a panic instead of silently making
a route unreachable. - fixed: Route matching is faster as number of routes increase.
- added: Wildcard routes like
- fixed: Correctly handle trailing slashes in routes:
- If a route with a trailing slash exists and a request without a trailing
slash is received, axum will send a 301 redirection to the route with the
trailing slash. - Or vice versa if a route without a trailing slash exists and a request
with a trailing slash is received. - This can be overridden by explicitly defining two routes: One with and one
without trailing a slash.
- If a route with a trailing slash exists and a request without a trailing
- breaking: Method routing for handlers have been moved from
axum::handler
toaxum::routing
. Soaxum::handler::get
now lives ataxum::routing::get
(#405) - breaking: Method routing for services have been moved from
axum::service
toaxum::routing
. Soaxum::service::get
now lives at, etc.
axum::routing::service_method_routing::get
, etc. (#405) - breaking:
Router::or
renamed toRouter::merge
and will now panic on
overlapping routes. It now only acceptsRouter
s and not generalService
s.
UseRouter::fallback
for adding fallback routes (#408) - added:
Router::fallback
for adding handlers for request that didn't
match any routes.Router::fallback
must be use instead ofnest("/", _)
(#408) - breaking:
EmptyRouter
has been renamed toMethodNotAllowed
as its only
used in method routers and not in path routers (Router
) - breaking: Remove support for routing based on the
CONNECT
method. An
example of combining axum with and HTTP proxy can be found here (#428)
- Big internal refactoring of routing leading to several improvements (#363)
- Extractors:
- fixed: Expand accepted content types for JSON requests (#378)
- fixed: Support deserializing
i128
andu128
inextract::Path
- breaking: Automatically do percent decoding in
extract::Path
(#272) - breaking: Change
Connected::connect_info
to returnSelf
and remove
the associated typeConnectInfo
(#396) - added: Add
extract::MatchedPath
for accessing path in router that
matched the request (#412)
- Error handling:
-
breaking: Simplify error handling model (#402):
- All services part of the router are now required to be infallible.
- Error handling utilities have been moved to an
error_handling
module. Router::check_infallible
has been removed since routers are always
infallible with the error handling changes.- Error handling closures must now handle all errors and thus always return
something that implementsIntoResponse
.
With these changes handling errors from fallible middleware is done like so:
use axum::{ routing::get, http::StatusCode, error_handling::HandleErrorLayer, response::IntoResponse, Router, BoxError, }; use tower::ServiceBuilder; use std::time::Duration; let middleware_stack = ServiceBuilder::new() // Handle errors from middleware // // This middleware most be added above any fallible // ones if you're using `ServiceBuilder`, due to how ordering works .layer(HandleErrorLayer::new(handle_error)) // Return an error after 30 seconds .timeout(Duration::from_secs(30)); let app = Router::new() .route("/", get(|| async { /* ... */ })) .layer(middleware_stack); fn handle_error(_error: BoxError) -> impl IntoResponse { StatusCode::REQUEST_TIMEOUT }
And handling errors from fallible leaf services is done like so:
use axum::{ Router, service, body::Body, routing::service_method_routing::get, response::IntoResponse, http::{Request, Response}, error_handling::HandleErrorExt, // for `.handle_error` }; use std::{io, convert::Infallible}; use tower::service_fn; let app = Router::new() .route( "/", get(service_fn(|_req: Request<Body>| async { let contents = tokio::fs::read_to_string("some_file").await?; Ok::<_, io::Error>(Response::new(Body::from(contents))) })) .handle_error(handle_io_error), ); fn handle_io_error(error: io::Error) -> impl IntoResponse { // ... }
-
- Misc: