Fixes #446

DOCUMENTATION.md

@@ -1049,6 +1049,10 @@ In the above scenario it is not clear which one of the two http handlers a user
 
 If you want to learn more about `Regex` please check the [Regular Expression Language Reference](https://docs.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference).
 
+#### routexp
+
+The `routexp` http handler is a combination of `routex` and `routef`. It resolves a route exactly like `routex`, but then passes the resolved Regex Groups as a `Seq<string>` parameter into the supplied handler function similar to how `routef` invokes the next handler in the pipeline.
+
 #### routeCix
 
 The `routeCix` http handler is the case insensitive version of `routex`:

RELEASE_NOTES.md

@@ -5,6 +5,7 @@ Release Notes
 
 - Fixed pre-conditions validation issue (see [#424](https://github.com/giraffe-fsharp/Giraffe/issues/424))
 - Fixed parsing issue with Guids and ShortIds in `Giraffe.EndpointRouting` (see [#447](https://github.com/giraffe-fsharp/Giraffe/issues/447))
+- Added `routexp` http handler to default router (see [#446](https://github.com/giraffe-fsharp/Giraffe/issues/446))
 
 ## 5.0.0-rc-1
 

src/Giraffe/Routing.fs

@@ -106,6 +106,28 @@ let routex (path : string) : HttpHandler =
         | true  -> next ctx
         | false -> skipPipeline
 
+/// <summary>
+/// Filters an incoming HTTP request based on the request path using Regex (case sensitive).
+///
+/// If the route matches the incoming HTTP request then the Regex groups will be passed into the supplied `routeHandler`.
+///
+/// This is similar to routex but also allows to use matched strings as parameters for a controller.
+/// </summary>
+/// <param name="path">Regex path.</param>
+/// <param name="routeHandler">A function which accepts a string sequence of the matched groups and returns a `HttpHandler` function which will subsequently deal with the request.</param>
+/// <returns>A Giraffe <see cref="HttpHandler"/> function which can be composed into a bigger web application.</returns>
+let routexp (path : string) (routeHandler : seq<string> -> HttpHandler): HttpHandler =
+    let pattern = sprintf "^%s$" path
+    let regex   = Regex(pattern, RegexOptions.Compiled)
+
+    fun (next : HttpFunc) (ctx : Microsoft.AspNetCore.Http.HttpContext) ->
+        let result  = regex.Match (SubRouting.getNextPartOfPath ctx)
+        match result.Success with
+        | true  ->
+            let args = result.Groups |> Seq.map (fun x -> x.Value)
+            routeHandler args next ctx
+        | false -> skipPipeline
+
 /// <summary>
 /// Filters an incoming HTTP request based on the request path using Regex (case insensitive).
 /// </summary>
@@ -123,7 +145,7 @@ let routeCix (path : string) : HttpHandler =
 /// <summary>
 /// Filters an incoming HTTP request based on the request path (case sensitive).
 /// If the route matches the incoming HTTP request then the arguments from the <see cref="Microsoft.FSharp.Core.PrintfFormat"/> will be automatically resolved and passed into the supplied routeHandler.
-/// 
+///
 /// Supported format chars**
 ///
 /// %b: bool
@@ -148,7 +170,7 @@ let routef (path : PrintfFormat<_,_,_,_, 'T>) (routeHandler : 'T -> HttpHandler)
 /// <summary>
 /// Filters an incoming HTTP request based on the request path.
 /// If the route matches the incoming HTTP request then the arguments from the <see cref="Microsoft.FSharp.Core.PrintfFormat"/> will be automatically resolved and passed into the supplied routeHandler.
-/// 
+///
 /// Supported format chars**
 ///
 /// %b: bool
@@ -226,7 +248,7 @@ let routeStartsWithCi (subPath : string) : HttpHandler =
 /// <summary>
 /// Filters an incoming HTTP request based on the beginning of the request path (case sensitive).
 /// If the route matches the incoming HTTP request then the arguments from the <see cref="Microsoft.FSharp.Core.PrintfFormat"/> will be automatically resolved and passed into the supplied routeHandler.
-/// 
+///
 /// Supported format chars**
 ///
 /// %b: bool
@@ -254,7 +276,7 @@ let routeStartsWithf (path : PrintfFormat<_,_,_,_, 'T>) (routeHandler : 'T -> Ht
 /// <summary>
 /// Filters an incoming HTTP request based on the beginning of the request path (case insensitive).
 /// If the route matches the incoming HTTP request then the arguments from the <see cref="Microsoft.FSharp.Core.PrintfFormat"/> will be automatically resolved and passed into the supplied routeHandler.
-/// 
+///
 /// Supported format chars**
 ///
 /// %b: bool
@@ -312,7 +334,7 @@ let subRouteCi (path : string) (handler : HttpHandler) : HttpHandler =
 /// <summary>
 /// Filters an incoming HTTP request based on a part of the request path (case sensitive).
 /// If the sub route matches the incoming HTTP request then the arguments from the <see cref="Microsoft.FSharp.Core.PrintfFormat"/> will be automatically resolved and passed into the supplied routeHandler.
-/// 
+///
 /// Supported format chars
 ///
 /// %b: bool
@@ -322,7 +344,7 @@ let subRouteCi (path : string) (handler : HttpHandler) : HttpHandler =
 /// %d: int64
 /// %f: float/double
 /// %O: Guid
-/// 
+///
 /// Subsequent routing handlers inside the given handler function should omit the already validated path.
 /// </summary>
 /// <param name="path">A format string representing the expected request sub path.</param>