From 2c54bb5b3b161f7c03ddd41105dfe0587c162f70 Mon Sep 17 00:00:00 2001 From: David Pedersen Date: Wed, 29 Jun 2022 21:32:41 +0200 Subject: [PATCH] fix doc tests --- axum/src/docs/routing/nest.md | 4 ++-- axum/src/docs/routing/route.md | 16 ---------------- axum/src/routing/tests/nest.rs | 2 +- 3 files changed, 3 insertions(+), 19 deletions(-) diff --git a/axum/src/docs/routing/nest.md b/axum/src/docs/routing/nest.md index a63b14df..5ec1df84 100644 --- a/axum/src/docs/routing/nest.md +++ b/axum/src/docs/routing/nest.md @@ -88,7 +88,7 @@ let serve_dir_service = get_service(ServeDir::new("public")) ) }); -let app = Router::new().nest("/public", serve_dir_service); +let app = Router::new().nest_service("/public", serve_dir_service); # async { # axum::Server::bind(&"".parse().unwrap()).serve(app.into_make_service()).await.unwrap(); # }; @@ -107,7 +107,7 @@ let app = Router::new() .route("/foo/*rest", get(|uri: Uri| async { // `uri` will contain `/foo` })) - .nest("/bar", get(|uri: Uri| async { + .nest_service("/bar", get(|uri: Uri| async { // `uri` will _not_ contain `/bar` })); # async { diff --git a/axum/src/docs/routing/route.md b/axum/src/docs/routing/route.md index e0a753a0..15f02788 100644 --- a/axum/src/docs/routing/route.md +++ b/axum/src/docs/routing/route.md @@ -184,22 +184,6 @@ let app = Router::new() The static route `/foo` and the dynamic route `/:key` are not considered to overlap and `/foo` will take precedence. -Take care when using [`Router::nest`] as it behaves like a wildcard route. -Therefore this setup panics: - -```rust,should_panic -use axum::{routing::get, Router}; - -let app = Router::new() - // this is similar to `/api/*` - .nest("/api", get(|| async {})) - // which overlaps with this route - .route("/api/users", get(|| async {})); -# async { -# axum::Server::bind(&"".parse().unwrap()).serve(app.into_make_service()).await.unwrap(); -# }; -``` - Also panics if `path` is empty. ## Nesting diff --git a/axum/src/routing/tests/nest.rs b/axum/src/routing/tests/nest.rs index 83b80a63..6c2a6c67 100644 --- a/axum/src/routing/tests/nest.rs +++ b/axum/src/routing/tests/nest.rs @@ -414,7 +414,7 @@ nested_route_test!(nest_3, nest = "", route = "/a/", expected = "/a/"); nested_route_test!(nest_4, nest = "/", route = "/", expected = "/"); nested_route_test!(nest_5, nest = "/", route = "/a", expected = "/a"); nested_route_test!(nest_6, nest = "/", route = "/a/", expected = "/a/"); -nested_route_test!(nest_7, nest = "/a", route = "/", expected = "/a",); +nested_route_test!(nest_7, nest = "/a/", route = "/", expected = "/a"); nested_route_test!(nest_8, nest = "/a", route = "/a", expected = "/a/a"); nested_route_test!(nest_9, nest = "/a", route = "/a/", expected = "/a/a/"); nested_route_test!(nest_11, nest = "/a/", route = "/", expected = "/a/");