feature: percent-decode before routing

axum-extra/src/extract/optional_path.rs

@@ -29,7 +29,7 @@ use serde::de::DeserializeOwned;
 ///
 /// let app = Router::new()
 ///     .route("/blog", get(render_blog))
-///     .route("/blog/:page", get(render_blog));
+///     .route("/blog/{page}", get(render_blog));
 /// # let app: Router = app;
 /// ```
 #[derive(Debug)]
@@ -77,7 +77,7 @@ mod tests {
 
         let app = Router::new()
             .route("/", get(handle))
-            .route("/:num", get(handle));
+            .route("/{num}", get(handle));
 
         let client = TestClient::new(app);
 

axum-extra/src/handler/mod.rs

@@ -95,7 +95,7 @@ pub trait HandlerCallWithExtractors<T, S>: Sized {
     /// }
     ///
     /// let app = Router::new().route(
-    ///     "/users/:id",
+    ///     "/users/{id}",
     ///     get(
     ///         // first try `admin`, if that rejects run `user`, finally falling back
     ///         // to `guest`

axum-extra/src/handler/or.rs

@@ -134,7 +134,7 @@ mod tests {
             "fallback"
         }
 
-        let app = Router::new().route("/:id", get(one.or(two).or(three)));
+        let app = Router::new().route("/{id}", get(one.or(two).or(three)));
 
         let client = TestClient::new(app);
 

axum-extra/src/protobuf.rs

@@ -82,7 +82,7 @@ use prost::Message;
 ///     # unimplemented!()
 /// }
 ///
-/// let app = Router::new().route("/users/:id", get(get_user));
+/// let app = Router::new().route("/users/{id}", get(get_user));
 /// # let _: Router = app;
 /// ```
 #[derive(Debug, Clone, Copy, Default)]

axum-extra/src/routing/mod.rs

@@ -371,11 +371,11 @@ mod tests {
     async fn tsr_with_params() {
         let app = Router::new()
             .route_with_tsr(
-                "/a/:a",
+                "/a/{a}",
                 get(|Path(param): Path<String>| async move { param }),
             )
             .route_with_tsr(
-                "/b/:b/",
+                "/b/{b}/",
                 get(|Path(param): Path<String>| async move { param }),
             );
 

axum-extra/src/routing/resource.rs

@@ -19,13 +19,13 @@ use axum::{
 ///     .create(|| async {})
 ///     // `GET /users/new`
 ///     .new(|| async {})
-///     // `GET /users/:users_id`
+///     // `GET /users/{users_id}`
 ///     .show(|Path(user_id): Path<u64>| async {})
-///     // `GET /users/:users_id/edit`
+///     // `GET /users/{users_id}/edit`
 ///     .edit(|Path(user_id): Path<u64>| async {})
-///     // `PUT or PATCH /users/:users_id`
+///     // `PUT or PATCH /users/{users_id}`
 ///     .update(|Path(user_id): Path<u64>| async {})
-///     // `DELETE /users/:users_id`
+///     // `DELETE /users/{users_id}`
 ///     .destroy(|Path(user_id): Path<u64>| async {});
 ///
 /// let app = Router::new().merge(users);
@@ -82,7 +82,9 @@ where
         self.route(&path, get(handler))
     }
 
-    /// Add a handler at `GET /{resource_name}/:{resource_name}_id`.
+    /// Add a handler at `GET /<resource_name>/{<resource_name>_id}`.
+    ///
+    /// For example when the resources are posts: `GET /post/{post_id}`.
     pub fn show<H, T>(self, handler: H) -> Self
     where
         H: Handler<T, S>,
@@ -92,17 +94,21 @@ where
         self.route(&path, get(handler))
     }
 
-    /// Add a handler at `GET /{resource_name}/:{resource_name}_id/edit`.
+    /// Add a handler at `GET /<resource_name>/{<resource_name>_id}/edit`.
+    ///
+    /// For example when the resources are posts: `GET /post/{post_id}/edit`.
     pub fn edit<H, T>(self, handler: H) -> Self
     where
         H: Handler<T, S>,
         T: 'static,
     {
-        let path = format!("/{0}/:{0}_id/edit", self.name);
+        let path = format!("/{0}/{{{0}_id}}/edit", self.name);
         self.route(&path, get(handler))
     }
 
-    /// Add a handler at `PUT or PATCH /resource_name/:{resource_name}_id`.
+    /// Add a handler at `PUT or PATCH /<resource_name>/{<resource_name>_id}`.
+    ///
+    /// For example when the resources are posts: `PUT /post/{post_id}`.
     pub fn update<H, T>(self, handler: H) -> Self
     where
         H: Handler<T, S>,
@@ -115,7 +121,9 @@ where
         )
     }
 
-    /// Add a handler at `DELETE /{resource_name}/:{resource_name}_id`.
+    /// Add a handler at `DELETE /<resource_name>/{<resource_name>_id}`.
+    ///
+    /// For example when the resources are posts: `DELETE /post/{post_id}`.
     pub fn destroy<H, T>(self, handler: H) -> Self
     where
         H: Handler<T, S>,
@@ -130,7 +138,7 @@ where
     }
 
     fn show_update_destroy_path(&self) -> String {
-        format!("/{0}/:{0}_id", self.name)
+        format!("/{0}/{{{0}_id}}", self.name)
     }
 
     fn route(mut self, path: &str, method_router: MethodRouter<S>) -> Self {

axum-extra/src/routing/typed.rs

@@ -19,15 +19,15 @@ use serde::Serialize;
 ///     RouterExt, // for `Router::typed_*`
 /// };
 ///
-/// // A type safe route with `/users/:id` as its associated path.
+/// // A type safe route with `/users/{id}` as its associated path.
 /// #[derive(TypedPath, Deserialize)]
-/// #[typed_path("/users/:id")]
+/// #[typed_path("/users/{id}")]
 /// struct UsersMember {
 ///     id: u32,
 /// }
 ///
 /// // A regular handler function that takes `UsersMember` as the first argument
-/// // and thus creates a typed connection between this handler and the `/users/:id` path.
+/// // and thus creates a typed connection between this handler and the `/users/{id}` path.
 /// //
 /// // The `TypedPath` must be the first argument to the function.
 /// async fn users_show(
@@ -39,7 +39,7 @@ use serde::Serialize;
 /// let app = Router::new()
 ///     // Add our typed route to the router.
 ///     //
-///     // The path will be inferred to `/users/:id` since `users_show`'s
+///     // The path will be inferred to `/users/{id}` since `users_show`'s
 ///     // first argument is `UsersMember` which implements `TypedPath`
 ///     .typed_get(users_show)
 ///     .typed_post(users_create)
@@ -75,7 +75,7 @@ use serde::Serialize;
 /// use axum_extra::routing::TypedPath;
 ///
 /// #[derive(TypedPath, Deserialize)]
-/// #[typed_path("/users/:id")]
+/// #[typed_path("/users/{id}")]
 /// struct UsersMember {
 ///     id: u32,
 /// }
@@ -100,7 +100,7 @@ use serde::Serialize;
 /// use axum_extra::routing::TypedPath;
 ///
 /// #[derive(TypedPath, Deserialize)]
-/// #[typed_path("/users/:id/teams/:team_id")]
+/// #[typed_path("/users/{id}/teams/{team_id}")]
 /// struct UsersMember {
 ///     id: u32,
 /// }
@@ -117,7 +117,7 @@ use serde::Serialize;
 /// struct UsersCollection;
 ///
 /// #[derive(TypedPath, Deserialize)]
-/// #[typed_path("/users/:id")]
+/// #[typed_path("/users/{id}")]
 /// struct UsersMember(u32);
 /// ```
 ///
@@ -130,7 +130,7 @@ use serde::Serialize;
 /// use axum_extra::routing::TypedPath;
 ///
 /// #[derive(TypedPath, Deserialize)]
-/// #[typed_path("/users/:id")]
+/// #[typed_path("/users/{id}")]
 /// struct UsersMember {
 ///     id: String,
 /// }
@@ -158,7 +158,7 @@ use serde::Serialize;
 /// };
 ///
 /// #[derive(TypedPath, Deserialize)]
-/// #[typed_path("/users/:id", rejection(UsersMemberRejection))]
+/// #[typed_path("/users/{id}", rejection(UsersMemberRejection))]
 /// struct UsersMember {
 ///     id: String,
 /// }
@@ -215,7 +215,7 @@ use serde::Serialize;
 /// [`Deserialize`]: serde::Deserialize
 /// [`PathRejection`]: axum::extract::rejection::PathRejection
 pub trait TypedPath: std::fmt::Display {
-    /// The path with optional captures such as `/users/:id`.
+    /// The path with optional captures such as `/users/{id}`.
     const PATH: &'static str;
 
     /// Convert the path into a `Uri`.
@@ -398,7 +398,7 @@ mod tests {
     use serde::Deserialize;
 
     #[derive(TypedPath, Deserialize)]
-    #[typed_path("/users/:id")]
+    #[typed_path("/users/{id}")]
     struct UsersShow {
         id: i32,
     }

axum-extra/src/typed_header.rs

@@ -30,7 +30,7 @@ use std::convert::Infallible;
 ///     // ...
 /// }
 ///
-/// let app = Router::new().route("/users/:user_id/team/:team_id", get(users_teams_show));
+/// let app = Router::new().route("/users/{user_id}/team/{team_id}", get(users_teams_show));
 /// # let _: Router = app;
 /// ```
 ///

axum-macros/src/typed_path.rs

@@ -386,8 +386,12 @@ fn parse_path(path: &LitStr) -> syn::Result<Vec<Segment>> {
         .split('/')
         .map(|segment| {
             if let Some(capture) = segment
-                .strip_prefix(':')
-                .or_else(|| segment.strip_prefix('*'))
+                .strip_prefix('{')
+                .and_then(|segment| segment.strip_suffix('}'))
+                .and_then(|segment| {
+                    (!segment.starts_with('{') && !segment.ends_with('}')).then_some(segment)
+                })
+                .map(|capture| capture.strip_prefix('*').unwrap_or(capture))
             {
                 Ok(Segment::Capture(capture.to_owned(), path.span()))
             } else {

axum-macros/tests/typed_path/fail/missing_field.rs

@@ -2,7 +2,7 @@ use axum_macros::TypedPath;
 use serde::Deserialize;
 
 #[derive(TypedPath, Deserialize)]
-#[typed_path("/users/:id")]
+#[typed_path("/users/{id}")]
 struct MyPath {}
 
 fn main() {

axum-macros/tests/typed_path/fail/missing_field.stderr

@@ -1,5 +1,5 @@
 error[E0026]: struct `MyPath` does not have a field named `id`
  --> tests/typed_path/fail/missing_field.rs:5:14
   |
-5 | #[typed_path("/users/:id")]
-  |              ^^^^^^^^^^^^ struct `MyPath` does not have this field
+5 | #[typed_path("/users/{id}")]
+  |              ^^^^^^^^^^^^^ struct `MyPath` does not have this field

axum-macros/tests/typed_path/fail/not_deserialize.rs

@@ -1,7 +1,7 @@
 use axum_macros::TypedPath;
 
 #[derive(TypedPath)]
-#[typed_path("/users/:id")]
+#[typed_path("/users/{id}")]
 struct MyPath {
     id: u32,
 }

axum-macros/tests/typed_path/fail/route_not_starting_with_slash_non_empty.rs

@@ -1,7 +1,7 @@
 use axum_extra::routing::TypedPath;
 
 #[derive(TypedPath)]
-#[typed_path(":foo")]
+#[typed_path("{foo}")]
 struct MyPath;
 
 fn main() {}

axum-macros/tests/typed_path/fail/route_not_starting_with_slash_non_empty.stderr

@@ -1,5 +1,5 @@
 error: paths must start with a `/`
  --> tests/typed_path/fail/route_not_starting_with_slash_non_empty.rs:4:14
   |
-4 | #[typed_path(":foo")]
-  |              ^^^^^^
+4 | #[typed_path("{foo}")]
+  |              ^^^^^^^

axum-macros/tests/typed_path/fail/unit_with_capture.rs

@@ -2,7 +2,7 @@ use axum_macros::TypedPath;
 use serde::Deserialize;
 
 #[derive(TypedPath, Deserialize)]
-#[typed_path("/users/:id")]
+#[typed_path("/users/{id}")]
 struct MyPath;
 
 fn main() {}

axum-macros/tests/typed_path/fail/unit_with_capture.stderr

@@ -1,5 +1,5 @@
 error: Typed paths for unit structs cannot contain captures
  --> tests/typed_path/fail/unit_with_capture.rs:5:14
   |
-5 | #[typed_path("/users/:id")]
-  |              ^^^^^^^^^^^^
+5 | #[typed_path("/users/{id}")]
+  |              ^^^^^^^^^^^^^

axum-macros/tests/typed_path/pass/customize_rejection.rs

@@ -6,7 +6,7 @@ use axum_extra::routing::{RouterExt, TypedPath};
 use serde::Deserialize;
 
 #[derive(TypedPath, Deserialize)]
-#[typed_path("/:foo", rejection(MyRejection))]
+#[typed_path("/{foo}", rejection(MyRejection))]
 struct MyPathNamed {
     foo: String,
 }
@@ -16,7 +16,7 @@ struct MyPathNamed {
 struct MyPathUnit;
 
 #[derive(TypedPath, Deserialize)]
-#[typed_path("/:foo", rejection(MyRejection))]
+#[typed_path("/{foo}", rejection(MyRejection))]
 struct MyPathUnnamed(String);
 
 struct MyRejection;

axum-macros/tests/typed_path/pass/into_uri.rs

@@ -3,13 +3,13 @@ use axum::http::Uri;
 use serde::Deserialize;
 
 #[derive(TypedPath, Deserialize)]
-#[typed_path("/:id")]
+#[typed_path("/{id}")]
 struct Named {
     id: u32,
 }
 
 #[derive(TypedPath, Deserialize)]
-#[typed_path("/:id")]
+#[typed_path("/{id}")]
 struct Unnamed(u32);
 
 #[derive(TypedPath, Deserialize)]

axum-macros/tests/typed_path/pass/named_fields_struct.rs

@@ -2,7 +2,7 @@ use axum_extra::routing::TypedPath;
 use serde::Deserialize;
 
 #[derive(TypedPath, Deserialize)]
-#[typed_path("/users/:user_id/teams/:team_id")]
+#[typed_path("/users/{user_id}/teams/{team_id}")]
 struct MyPath {
     user_id: u32,
     team_id: u32,
@@ -11,7 +11,7 @@ struct MyPath {
 fn main() {
     _ = axum::Router::<()>::new().route("/", axum::routing::get(|_: MyPath| async {}));
 
-    assert_eq!(MyPath::PATH, "/users/:user_id/teams/:team_id");
+    assert_eq!(MyPath::PATH, "/users/{user_id}/teams/{team_id}");
     assert_eq!(
         format!(
             "{}",

axum-macros/tests/typed_path/pass/option_result.rs

@@ -3,7 +3,7 @@ use axum::{extract::rejection::PathRejection, http::StatusCode};
 use serde::Deserialize;
 
 #[derive(TypedPath, Deserialize)]
-#[typed_path("/users/:id")]
+#[typed_path("/users/{id}")]
 struct UsersShow {
     id: String,
 }

axum-macros/tests/typed_path/pass/tuple_struct.rs

@@ -4,12 +4,12 @@ use serde::Deserialize;
 pub type Result<T> = std::result::Result<T, ()>;
 
 #[derive(TypedPath, Deserialize)]
-#[typed_path("/users/:user_id/teams/:team_id")]
+#[typed_path("/users/{user_id}/teams/{team_id}")]
 struct MyPath(u32, u32);
 
 fn main() {
     _ = axum::Router::<()>::new().route("/", axum::routing::get(|_: MyPath| async {}));
 
-    assert_eq!(MyPath::PATH, "/users/:user_id/teams/:team_id");
+    assert_eq!(MyPath::PATH, "/users/{user_id}/teams/{team_id}");
     assert_eq!(format!("{}", MyPath(1, 2)), "/users/1/teams/2");
 }

axum-macros/tests/typed_path/pass/url_encoding.rs

@@ -2,13 +2,13 @@ use axum_extra::routing::TypedPath;
 use serde::Deserialize;
 
 #[derive(TypedPath, Deserialize)]
-#[typed_path("/:param")]
+#[typed_path("/{param}")]
 struct Named {
     param: String,
 }
 
 #[derive(TypedPath, Deserialize)]
-#[typed_path("/:param")]
+#[typed_path("/{param}")]
 struct Unnamed(String);
 
 fn main() {