rawPathPrefixTest
Description
Checks whether the unmatched path of the RequestContext
RequestContext
has a prefix matched by the given PathMatcher
. Potentially extracts one or more values (depending on the type of the argument) but doesn’t consume its match from the unmatched path.
This directive is very similar to the pathPrefix directive with the one difference that the path prefix it matched (if it matched) is not consumed. The unmatched path of the RequestContext
RequestContext
is therefore left as is even in the case that the directive successfully matched and the request is passed on to its inner route.
For more info on how to create a PathMatcher
see The PathMatcher DSL.
As opposed to its pathPrefixTest counterpart rawPathPrefixTest
does not automatically add a leading slash to its PathMatcher
argument. Rather its PathMatcher
argument is applied to the unmatched path as is.
Depending on the type of its PathMatcher
argument the rawPathPrefixTest
directive extracts zero or more values from the URI. If the match fails the request is rejected with an empty rejection set.
Example
- Scala
-
source
val completeWithUnmatchedPath = extractUnmatchedPath { p => complete(p.toString) } val route = pathPrefix("foo") { rawPathPrefixTest("bar") { completeWithUnmatchedPath } } // tests: Get("/foobar") ~> route ~> check { responseAs[String] shouldEqual "bar" } Get("/foobaz") ~> route ~> check { handled shouldEqual false }
- Java
-
source
import static org.apache.pekko.http.javadsl.server.Directives.complete; import static org.apache.pekko.http.javadsl.server.Directives.rawPathPrefixTest; final Route route = concat( pathPrefix( "foo", () -> rawPathPrefixTest("bar", () -> completeWithUnmatchedPath.get()))); // tests: testRoute(route).run(HttpRequest.GET("/foobar")).assertEntity("bar"); testRoute(route).run(HttpRequest.GET("/foobaz")).assertStatusCode(StatusCodes.NOT_FOUND);